Saltar al contenido principal
Los planes Pro y Custom incluyen verificaciones de CI para repositorios de GitHub.
Usa las verificaciones de CI para analizar tu documentación, detectar errores y mostrar advertencias antes de implementar. Las verificaciones de CI de Mintlify se ejecutan en solicitudes de extracción contra una rama de implementación configurada.

​
Instalación

Para comenzar, sigue los pasos en la página de GitHub.
Solo se necesita acceso al repositorio donde se encuentra el contenido de tu documentación, por lo que se recomienda encarecidamente otorgar acceso únicamente a ese repositorio.

​
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 comprobaciones, puedes elegir ejecutarlas con nivel de Advertencia o Bloqueo.
  • Una comprobación con nivel Advertencia nunca devolverá un estado de error, incluso si hay errores o sugerencias.
  • Una comprobación con nivel Bloqueo devolverá un estado de error si hay errores o sugerencias.

​
Comprobaciones de CI disponibles

De forma similar al funcionamiento del verificador de enlaces de la CLI en tu máquina local, la verificación de CI de enlaces rotos busca automáticamente en el contenido de tu documentación enlaces internos que no funcionan. 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. Usa Vale para comprobar la coherencia del estilo y el tono en tu documentación. Mintlify admite 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, la verificación de Vale CI usa ese archivo de configuración y cualquier archivo de configuración en el stylesPath que especifiques. 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
# Etiquetas HTML en línea a ignorar (code/tt para fragmentos de código, img/url para enlaces/imágenes, a para etiquetas ancla)
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure

# Vocabularios
Vocab = Mintlify

# Paquetes
Packages = MDX

# Coincidir solo con MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Aplica reglas de mayúsculas muy estrictas, mantener desactivado

# Ignorar patrones de sintaxis específicos de JSX/MDX
# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Excluir JSX multilínea y llaves
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
El vocabulario predeterminado de Vale incluye las siguientes palabras.
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

_italic_
Strikethrough
Blockquotes
Blockquote
Singleline
Multiline

onboarding

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
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
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

todo
href
lang
nav
prev
next
toc
Para agregar tu propio vocabulario a la configuración predeterminada, crea un directorio styles/config/vocabularies/Mintlify con los archivos accept.txt y reject.txt.
  • accept.txt: Palabras que deben ser ignoradas por el linter Vale. Por ejemplo, nombres de productos o términos poco comunes.
  • reject.txt: Palabras que deben marcarse como errores. Por ejemplo, jerga o palabras que no son apropiadas para el tono de tu documentación.
Example Vale file structure
/your-project
  |- docs.json
  |- .vale.ini
  |- styles/
    |- config/
      |- vocabularies/
        |- Mintlify/
          |- accept.txt
          |- reject.txt
  |- example-page.mdx
Example monorepo Vale file structure
/your-monorepo
  |- main.ts
  |- docs/
    |- docs.json
    |- .vale.ini
    |- styles/
      |- config/
      |- vocabularies/
        |- Mintlify/
          |- accept.txt
          |- reject.txt
    |- example-page.mdx
  |- test/
Por razones de seguridad, no se admite el uso de un stylesPath absoluto ni de un stylesPath que incluya ...Usa rutas relativas e incluye el stylesPath en tu repositorio.

​
Paquetes

Vale es compatible con una variedad de paquetes, que puedes usar para detectar errores ortográficos y de estilo. Cualquier paquete que incluyas en tu repositorio bajo el stylesPath correcto se instala automáticamente y se utiliza en tu configuración de Vale. Para los paquetes que no estén incluidos en tu repositorio, puedes especificar cualquiera del registro de paquetes de Vale; se descargarán automáticamente y se utilizarán en tu configuración de Vale.
Por motivos de seguridad, no se admite la descarga automática de paquetes que no provengan del registro de paquetes de Vale.

​
Vale con MDX

La compatibilidad nativa con MDX requiere Vale 3.10.0 o posterior. Comprueba tu versión de Vale con vale --version.
Para usar los comentarios dentro del documento de Vale en archivos MDX, utiliza comentarios al estilo MDX {/* ... */}: 
{/* vale off */}

Este texto es ignorado por Vale

{/* vale on */}
Vale reconoce y respeta automáticamente estos comentarios en los archivos MDX sin necesidad de configuración adicional. Usa los comentarios para omitir líneas o secciones que el linter deba ignorar.