Os planos Pro e Enterprise incluem verificações de CI para repositórios do GitHub.
Use as verificações de CI para verificar suas docs em busca de erros e exibir avisos antes de implantar. As verificações de CI são configuradas para serem executadas em commits no branch de implantação configurado ou em pull requests direcionados a esse branch.

​
Instalação

Para começar, siga as etapas na página do GitHub. Para GitHub Apps, você pode conceder permissões apenas a um único repositório. Recomendamos fortemente que faça isso, pois só precisamos de acesso ao repositório onde sua documentação está hospedada.

​
Configuração

Configure as verificações de CI ativadas para uma implantação acessando a página de Add-ons do seu painel. Ative as verificações que você deseja executar. Ao ativar as verificações, você pode escolher executá-las nos níveis Warning ou Blocking.
  • Uma verificação no nível Warning nunca exibirá status de falha, mesmo que haja erros ou sugestões.
  • Uma verificação no nível Blocking exibirá status de falha se não for aprovada ou se alterações forem sugeridas.

​
Verificações de CI disponíveis

Assim como o verificador de links da CLI funciona na sua máquina local, verificamos automaticamente sua documentação em busca de links quebrados. Para ver os resultados dessa verificação, visite a página de resultados de checks do GitHub para um commit específico.

​
Vale

Vale é um linter de prosa de código aberto, baseado em regras, que oferece suporte a diversos tipos de documentos, incluindo Markdown e MDX. A Mintlify oferece suporte à execução automática do Vale em uma checagem de CI e à exibição dos resultados como um status de verificação.

​
Configuração

Se você tiver um arquivo .vale.ini no diretório raiz de conteúdo da sua implantação, usaremos automaticamente esse arquivo de configuração. Também usaremos automaticamente quaisquer arquivos de configuração no stylesPath que você especificar. Se você não tiver um arquivo de configuração do Vale, a configuração padrão será carregada automaticamente.
Default vale.ini configuration
# Top level styles
StylesPath = /app/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

# Vocabularies
Vocab = Mintlify

# This is required since Vale doesn't officially support MDX
[formats]
mdx = md

# MDX support
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Enforces really harsh capitalization rules, keep off

# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Exclude:
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

CommentDelimiters = {/*, */}
Default Vale vocabulary
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
Observe que, por motivos de segurança, não damos suporte a nenhum stylesPath absoluto nem a stylesPath que incluam valores ... Use caminhos relativos e inclua o stylesPath no seu repositório.

​
Pacotes

O Vale oferece suporte a uma variedade de pacotes, que podem ser usados para verificar erros de ortografia e estilo. Quaisquer pacotes que você incluir no seu repositório no stylesPath correto serão instalados automaticamente e usados na sua configuração do Vale. Para pacotes que não estejam no seu repositório, você pode especificar qualquer pacote do registro de pacotes do Vale; eles serão baixados e usados automaticamente na sua configuração do Vale.
Observe que, por motivos de segurança, não é possível fazer o download automático de pacotes que não sejam do registro de pacotes do Vale.

​
Vale com MDX

O Vale não oferece suporte nativo a MDX, mas o autor do Vale disponibilizou uma extensão personalizada para adicioná-lo. Se você preferir não usar essa extensão, recomendamos as seguintes linhas no seu arquivo .vale.ini: 
[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
Para usar comentários em linha do Vale, use comentários no estilo MDX {/* ... */}. Se você definir a chave CommentDelimiters = {/*, */} na sua configuração, o Vale interpretará esses comentários automaticamente durante a análise. Isso permite usar facilmente os recursos nativos do Vale, como ignorar linhas ou seções. 
{/* vale off */}

Este texto será ignorado pelo Vale

{/* vale on */}
Se você optar por não usar CommentDelimiters, mas ainda quiser usar os comentários do Vale, envolva qualquer comentário do Vale em comentários MDX {/* ... */}. Por exemplo: 
{/* <!-- vale off --> */}

Este texto será ignorado pelo Vale

{/* <!-- vale on --> */}
Essas tags de comentário não são compatíveis dentro dos Componentes (Mintlify), mas podem ser usadas em qualquer lugar no nível base de um documento.