mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
8b31949b1b
* fix: resolve cross-page contradictions in deploy directory * docs: mirror deploy audit fixes into es, fr, and zh translations --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
446 lines
8.6 KiB
Plaintext
446 lines
8.6 KiB
Plaintext
---
|
|
title: "Verificaciones de CI"
|
|
description: "Automatiza verificaciones de calidad de la documentación en tu pipeline de CI/CD con detección de enlaces rotos, linting y vistas previas de build."
|
|
keywords: ["integración continua", "CI/CD", "verificaciones", "Vale", "linter"]
|
|
---
|
|
|
|
<Info>
|
|
Los [planes Pro y Enterprise](https://mintlify.com/pricing?ref=docs-ci) incluyen verificaciones de CI para repositorios de GitHub.
|
|
</Info>
|
|
|
|
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.
|
|
|
|
<div id="installation">
|
|
## Instalación
|
|
</div>
|
|
|
|
Para comenzar, sigue los pasos en la página de [GitHub](/es/deploy/github).
|
|
|
|
<Tip>
|
|
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.
|
|
</Tip>
|
|
|
|
## Configuración
|
|
|
|
Configura las comprobaciones de CI habilitadas para una implementación desde la página de [Add-ons](https://app.mintlify.com/settings/deployment/addons) 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.
|
|
|
|
<div id="available-ci-checks">
|
|
## Comprobaciones de CI disponibles
|
|
</div>
|
|
|
|
<div id="broken-links">
|
|
### Enlaces rotos
|
|
</div>
|
|
|
|
De forma similar al funcionamiento del [verificador de enlaces de la CLI](/es/cli/commands#mint-broken-links) 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.
|
|
|
|
<div id="vale">
|
|
### Vale
|
|
</div>
|
|
|
|
[Vale](https://vale.sh/) 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.
|
|
|
|
<div id="configuration">
|
|
#### Configuración
|
|
</div>
|
|
|
|
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.
|
|
|
|
<Note>
|
|
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.
|
|
</Note>
|
|
|
|
```mdx Default vale.ini configuration expandable
|
|
# Top level styles
|
|
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
|
|
|
|
# Vocabularies
|
|
Vocab = Mintlify
|
|
|
|
# Parse MDX as MD to avoid fragility with JSX
|
|
[formats]
|
|
mdx = md
|
|
|
|
# Only match MDX
|
|
[*.mdx]
|
|
BasedOnStyles = Vale
|
|
Vale.Terms = NO # Enforces really harsh capitalization rules, keep off
|
|
|
|
# Ignore JSX/MDX-specific syntax patterns
|
|
# `import ...`, `export ...`
|
|
# `<Component ... />`
|
|
# `<Component>...</Component>`
|
|
# `{ ... }`
|
|
TokenIgnores = (?sm)((?:import|export) .+?$), \
|
|
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
|
|
(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \
|
|
\{[^}]*\}
|
|
|
|
# Exclude multiline JSX and curly braces
|
|
# `<Component \n ... />`
|
|
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
|
|
(?sm)^({.+.*})
|
|
```
|
|
|
|
El vocabulario predeterminado de Vale incluye las siguientes palabras.
|
|
|
|
```text Default Vale vocabulary expandable
|
|
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 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.
|
|
|
|
```text Example Vale file structure
|
|
/your-project
|
|
|- docs.json
|
|
|- .vale.ini
|
|
|- styles/
|
|
|- config/
|
|
|- vocabularies/
|
|
|- Mintlify/
|
|
|- accept.txt
|
|
|- reject.txt
|
|
|- example-page.mdx
|
|
```
|
|
|
|
```text 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/
|
|
```
|
|
|
|
<div id="packages">
|
|
#### Paquetes
|
|
</div>
|
|
|
|
Vale es compatible con una variedad de [paquetes](https://vale.sh/docs/keys/packages) 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](https://vale.sh/explorer); se descargarán automáticamente y se utilizarán en tu configuración de Vale.
|
|
|
|
<Note>
|
|
Por motivos de seguridad, no puedes descargar automáticamente paquetes que no provengan del [registro de paquetes de Vale](https://vale.sh/explorer).
|
|
</Note>
|
|
|
|
<div id="vale-with-mdx">
|
|
#### Vale con `MDX`
|
|
</div>
|
|
|
|
<Note>
|
|
La compatibilidad nativa con MDX requiere Vale 3.10.0 o posterior. Comprueba tu versión de Vale con `vale --version`.
|
|
</Note>
|
|
|
|
Para usar los comentarios dentro del documento de Vale en archivos MDX, utiliza comentarios al estilo MDX `{/* ... */}`:
|
|
|
|
```mdx
|
|
{/* vale off */}
|
|
|
|
Vale ignora este texto
|
|
|
|
{/* 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 quieras que el linter ignore.
|
|
|
|
<Warning>
|
|
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.
|
|
</Warning>
|