Skip to main content
Los planes Pro y Enterprise incluyen comprobaciones de CI para repositorios de GitHub.
Usa las comprobaciones de CI para analizar tu documentación en busca de errores y mostrar advertencias antes del despliegue. Las comprobaciones de CI se configuran para ejecutarse en los commits a la rama de despliegue configurada o en los pull requests contra esa rama.

​
Instalación

Para comenzar, sigue los pasos en la página de GitHub. En el caso de las GitHub Apps, puedes otorgar permisos solo a un repositorio. Te recomendamos hacerlo, ya que solo necesitamos acceso al repositorio donde se alojan tu documentación.

​
Configuración

Configura las verificaciones de CI habilitadas para un despliegue desde la página de Add-ons de tu panel. Activa las verificaciones que quieras ejecutar. Al habilitar verificaciones, puedes elegir ejecutarlas con nivel Warning o Blocking.
  • Una verificación de nivel Warning nunca marcará un estado de error, incluso si hay errores o sugerencias.
  • Una verificación de nivel Blocking marcará un estado de error si no se aprueba o si se sugieren cambios.

​
Comprobaciones de CI disponibles

Al igual que el verificador 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 comprobación, visita la página de resultados de comprobaciones de GitHub para un commit concreto.

​
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 despliegue, usaremos automáticamente ese archivo de configuración. También utilizaremos 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.
Configuración predeterminada de vale.ini expandible
Vocabulario predeterminado de Vale desplegable
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 se pueden usar para comprobar errores ortográficos y de estilo. Cualquier paquete que incluya en su repositorio bajo el stylesPath correcto se instalará automáticamente y se usará 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 automáticamente y se usarán 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 es compatible de forma nativa con MDX, pero el autor de Vale ha proporcionado una extensión personalizada para admitirlo. Si prefiere no usar esta extensión, recomendamos las siguientes líneas en su archivo .vale.ini:
Para usar los comentarios en el documento de Vale, utiliza comentarios con estilo MDX {/* ... */}. Si en tu configuración estableces la opción CommentDelimiters = {/*, */} configuración, Vale interpreta automáticamente estos comentarios durante el análisis. Esto significa que puedes utilizar fácilmente las funciones integradas de Vale, como omitir líneas o secciones.
Si decides no usar CommentDelimiters pero aun así usar los comentarios de Vale, debes envolver cualquier comentario de Vale en comentarios de MDX {/* ... */}. Por ejemplo:
Estas etiquetas de comentario no son compatibles dentro de los componentes de Mintlify, pero pueden usarse en cualquier parte del nivel base de un documento.