Verificaciones de CI

Añade verificaciones para enlaces rotos, linting y gramática al proceso de actualización

Los planes Pro y Enterprise incluyen verificaciones de CI para repositorios de GitHub.

Usa las verificaciones de CI para analizar tu documentación en busca de errores y mostrar advertencias antes de implementar. Las verificaciones de CI se configuran para ejecutarse en cada commit a tu rama de implementación configurada o en las pull requests dirigidas a esa rama.

​

Instalación

Para comenzar, sigue los pasos en la página de GitHub.

Para la Aplicación de GitHub, puedes elegir otorgar permisos solo a un único repositorio. Te recomendamos hacerlo, ya que solo necesitamos acceso al repositorio donde se aloja tu documentación.

​

Configuración

Configura las comprobaciones de CI habilitadas para una implementación desde la página de Add-ons de tu dashboard. Activa las comprobaciones que quieras ejecutar.

Al habilitar las comprobaciones, puedes elegir ejecutarlas con nivel de Advertencia o Bloqueo.

• Una comprobación con nivel Advertencia nunca marcará un estado de error, incluso si hay errores o sugerencias.
• Una comprobación con nivel Bloqueo marcará un estado de error si no se supera o si se sugieren cambios.

​

Comprobaciones de CI disponibles

​

Enlaces rotos

De forma similar a cómo funciona el comprobador de enlaces de la CLI en tu máquina local, comprobamos automáticamente si tu documentación tiene enlaces rotos.

Para ver los resultados de esta verificación, visita la página de resultados de comprobaciones de GitHub para una confirmación específica.

​

Vale

Vale es un linter de prosa de código abierto basado en reglas que admite una variedad de tipos de documentos, incluidos Markdown y MDX.

Mintlify permite ejecutar Vale automáticamente en una comprobación de CI y mostrar los resultados como un estado de comprobación.

​

Configuración

Si tienes un archivo .vale.ini en el directorio raíz de contenido de tu implementación, usaremos automáticamente ese archivo de configuración. También usaremos automáticamente cualquier archivo de configuración en el stylesPath que hayas especificado.

Si no tienes un archivo de configuración de Vale, se cargará automáticamente la configuración predeterminada.

Default vale.ini configuration

# Estilos de nivel superior
StylesPath = /app/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

# Vocabularios
Vocab = Mintlify

# Esto es obligatorio ya que Vale no soporta oficialmente MDX
[formats]
mdx = md

# Soporte para MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Aplica reglas de capitalización muy estrictas, mantener desactivado

# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Excluir:
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

CommentDelimiters = {/*, */}

Default Vale vocabulary

Mintlify
Mintlify
VSCode
openapi
OpenAPI
GitHub
APIs

repo
npm
dev

Lorem
ipsum
impsum
amet

const
myName
myObject
bearerAuth
favicon
topbar
url
borderRadius
args
modeToggle
ModeToggle
isHidden
autoplay

_cursiva_
Tachado
Citas en bloque
Cita en bloque
Una línea
Múltiples líneas

incorporación

async
await
boolean
enum
func
impl
init
instanceof
typeof
params
stdin
stdout
stderr
stdout
stdin
var
const
let
null
undefined
struct
bool

cors
csrf
env
xhr
xhr2
JWT (JSON Web Token)
OAuth
websocket
localhost
middleware
runtime
webhook
stdin
stdout

json
yaml
yml
md
txt
tsx
jsx
css
scss
html
png
jpg
svg

cdn
CLI
css
dom
dto
env
Git
gui
http
https
ide
jvm
mvc
orm
rpc
SDK
sql
ssh
ssl
tcp
tls
uri
url
ux
ui

nodejs
npm
yarn
pnpm
eslint
pytest
golang
rustc
kubectl
mongo
postgres
redis

JavaScript
TypeScript
Python
Ruby
Rust
Go
Golang
Java
Kotlin
Swift
Node.js
NodeJS
Deno

React
Vue
Angular
Next.js
Nuxt
Express
Django
Flask
Spring
Laravel
Redux
Vuex
TensorFlow
PostgreSQL
MongoDB
Redis
PNPM

Docker
Kubernetes
AWS
Azure
GCP
Terraform
Jenkins
CircleCI
GitLab
Heroku

Git
git
GitHub
GitLab
Bitbucket
VSCode
Visual Studio Code
IntelliJ
WebStorm
ESLint
eslint
Prettier
prettier
Webpack
webpack
Vite
vite
Babel
babel
Jest
jest
Mocha
Cypress
Postman

HTTP
HTTPS
OAuth
JWT (JSON Web Token)
GraphQL
REST
WebSocket
TCP/IP

NPM
Yarn
PNPM
Pip
PIP
Cargo
RubyGems

Swagger
OpenAPI
Markdown
MDX
Storybook
TypeDoc
JSDoc

MySQL
PostgreSQL
MongoDB
Redis
Elasticsearch
DynamoDB

Linux
Unix
macOS
iOS

Firefox
Chromium
WebKit

config
ctx
desc
dir
elem
err
len
msg
num
obj
prev
proc
ptr
req
res
str
tmp
val
vars

pendiente
href
idioma
navegación
anterior
siguiente
tabla de contenidos

Tenga en cuenta que, por razones de seguridad, no podemos admitir ningún stylesPath absoluto ni stylesPath que incluya valores ... Use rutas relativas e incluya el stylesPath en su repositorio.

​

Paquetes

Vale admite una variedad de paquetes que pueden usarse para comprobar errores ortográficos y de estilo. Cualquier paquete que incluya en su repositorio en el stylesPath correcto se instalará y utilizará automáticamente en su configuración de Vale.

Para los paquetes que no estén incluidos en su repositorio, puede especificar cualquiera del registro de paquetes de Vale; se descargarán y utilizarán automáticamente en su configuración de Vale.

Tenga en cuenta que, por razones de seguridad, no podemos admitir la descarga automática de paquetes que no provengan del registro de paquetes de Vale.

​

Vale con MDX

Vale no admite MDX de forma nativa, pero el autor de Vale ha proporcionado una extensión personalizada para darle soporte.

Si prefiere no usar esta extensión, recomendamos las siguientes líneas en su archivo .vale.ini:

[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

Para usar los comentarios en el documento de Vale, utiliza comentarios con el estilo de MDX {/* ... */}. Si usas el ajuste CommentDelimiters = {/*, */} en tu configuración, Vale interpretará automáticamente estos comentarios durante el linting. Esto significa que puedes usar fácilmente las funciones integradas de Vale, como omitir líneas o secciones.

{/* vale off */}

Este texto será ignorado por Vale

{/* vale on */}

Si decides no usar CommentDelimiters pero aun así quieres usar los comentarios de Vale, debes envolver cualquier comentario de Vale en comentarios de MDX {/* ... */}. Por ejemplo:

{/* <!-- vale off --> */}

Este texto será ignorado por Vale

{/* <!-- vale on --> */}

Estas etiquetas de comentario no se admiten dentro de los componentes de Mintlify, pero pueden utilizarse en cualquier parte del nivel base de un documento.