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.
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.
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
.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
# Estilos de nivel superior
StylesPath = /app/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code
# Vocabularies
Vocab = Mintlify
# Esto es necesario porque Vale no admite oficialmente MDX
[formats]
mdx = md
# Compatibilidad con MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Aplica reglas de capitalización muy estrictas; mantener desactivado
# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
# Excluir:
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
CommentDelimiters = {/*, */}
Vocabulario predeterminado de Vale desplegable
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_
Tachado
Bloques de cita
Bloque de cita
Una línea
Multilínea
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
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.
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. 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:
[formats]
mdx = md
[*.mdx]
CommentDelimiters = {/*, */}
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
{/* ... */}. 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.
{/* vale off */}
Este texto será ignorado por Vale
{/* vale on */}
CommentDelimiters pero aun así usar los comentarios de Vale, debes envolver cualquier comentario de Vale en comentarios de MDX {/* ... */}. Por ejemplo:
{/* <!-- vale off --> */}
Este texto será ignorado por Vale
{/* <!-- vale on --> */}
