Saltar al contenido principal
Los planes Pro y Enterprise 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.
La aplicación GitHub de Mintlify solo necesita acceso al repositorio donde se encuentra el contenido de tu documentación. Recomendamos 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 devuelve un estado de error, incluso si hay errores o sugerencias.
  • Una comprobación con nivel Bloqueo devuelve 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 rotos entre las páginas de tu sitio. No verifica enlaces externos a otros sitios web. Para ver los resultados detallados de enlaces rotos en una solicitud de extracción, haz clic en la pestaña Checks y selecciona la verificación de enlaces rotos de Mintlify. Los resultados listan los archivos con enlaces rotos encontrados en la solicitud de extracción.

​
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.
La configuración predeterminada se ejecuta en el entorno de compilación de Mintlify, donde StylesPath = /app/styles apunta a un directorio interno. Si creas tu propio archivo .vale.ini, usa una ruta relativa dentro de tu repositorio, como StylesPath = styles.Por razones de seguridad, no puedes usar rutas absolutas ni rutas que contengan .. en tus archivos de configuración.
Default vale.ini configuration
El vocabulario predeterminado de Vale incluye las siguientes palabras.
Default Vale vocabulary
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 el linter Vale debe ignorar. Por ejemplo, nombres de productos o términos poco comunes.
  • reject.txt: Palabras que el linter Vale debe marcar como errores. Por ejemplo, jerga o palabras que no son apropiadas para el tono de tu documentación.
Example Vale file structure
Example monorepo Vale file structure

​
Paquetes

Vale es compatible con una variedad de paquetes que detectan errores ortográficos y de estilo. Cualquier paquete que incluyas en tu repositorio bajo el StylesPath correcto se instala y ejecuta automáticamente con 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 puedes descargar automáticamente 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 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 quieras que el linter ignore.
No coloques {/* vale off */} o comentarios de expresión MDX similares como hijos directos de un componente JSX entre elementos hermanos. Por ejemplo, entre dos elementos <Step> dentro de un componente <Steps>.Coloca los comentarios dentro del contenido de un elemento específico o reestructura el contenido para evitar la necesidad de comentarios.