Ci

Esta función solo está disponible para clientes con planes de pago y para GitHub. El soporte para otras plataformas estará disponible pronto. Por favor contacte a ventas para más información.

Utilice comprobaciones de CI para revisar sus documentos en busca de errores y recibir advertencias antes de implementar.

Instalación

Para comenzar, necesitará haber seguido los pasos en la página de GitHub.

Para las aplicaciones de GitHub, puede elegir dar permisos solo a un repositorio individual. Recomendamos encarecidamente que lo haga, ya que solo necesitamos acceso al repositorio donde se alojan sus documentos.

Configuración

Puede configurar las comprobaciones de CI habilitadas para una implementación en el panel de Mintlify navegando a la pestaña ‘Add-Ons’. Allí puede habilitar o deshabilitar las comprobaciones que desea ejecutar.

Al habilitar las comprobaciones, puede elegir ejecutarlas a nivel Warning o Blocking.

Una comprobación de nivel Blocking proporcionará un estado de fallo si no se pasa o se sugieren cambios.

Una comprobación de nivel Warning nunca proporcionará un estado de fallo, incluso si hay un error o sugerencias.

¿Cuándo se ejecutan?

Las comprobaciones de CI están configuradas para ejecutarse en commits a su rama de implementación configurada, o en pull requests contra esa rama.

Comprobaciones de CI disponibles

Enlaces rotos

De manera similar a cómo funciona el comprobador de enlaces de CLI en su máquina local, verificaremos automáticamente sus documentos en busca de enlaces rotos. Para ver los resultados de esta comprobación, puede visitar la página de resultados de comprobación de GitHub para un commit específico.

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 admite la ejecución automática de Vale en una comprobación de CI y muestra los resultados como un estado de comprobación.

Configuración

Si tiene un archivo .vale.ini en la raíz del directorio de contenido para su implementación, usaremos automáticamente ese archivo de configuración. También usaremos automáticamente cualquier archivo de configuración en su stylesPath especificado.

¿No tiene una configuración de Vale o no está seguro de por dónde empezar? No se preocupe, Mintlify tiene una configuración predeterminada que se utilizará automáticamente si no se proporciona una.

Tenga en cuenta que por razones de seguridad, no podemos admitir ninguna ruta absoluta stylesPath, o stylesPath que incluyan valores ... Utilice rutas relativas e incluya el stylesPath en su repositorio.

Paquetes

Vale admite una variedad de paquetes, que se pueden usar para verificar errores de ortografía y estilo. Cualquier paquete que incluya en su repositorio bajo el stylesPath correcto se instalará y utilizará automáticamente en su configuración de Vale.

Para paquetes no incluidos en su repositorio, puede especificar cualquier paquete del registro de paquetes de Vale, y 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 sean 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 admitirlo.

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

[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, use comentarios de estilo MDX {/* ... */}. Si usa la configuración CommentDelimiters = {/*, */} setting en su configuración, Vale interpretará automáticamente estos comentarios mientras realiza el linting. Esto significa que puede usar fácilmente las funciones incorporadas de Vale, como omitir líneas o secciones.

{/* vale off */}

This text will be ignored by Vale

{/* vale on */}

Si elige no usar CommentDelimiters, pero aún elige usar los comentarios de Vale, debe envolver cualquier comentario de Vale en comentarios MDX {/* ... */}. Por ejemplo:

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

This text will be ignored by Vale

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

Tenga en cuenta que estas etiquetas de comentarios no son compatibles dentro de los componentes de Mintlify, pero se pueden usar en cualquier lugar en el nivel base de un documento.