Skip to main content
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

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
Default Vale vocabulary
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:
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.
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:
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.