I piani Pro ed Enterprise includono verifiche CI per i repository GitHub.
Usa le verifiche CI per eseguire il linting della documentazione, individuare errori e fornire avvisi prima del deployment. Le verifiche CI sono configurate per essere eseguite sui commit nel branch di deployment configurato o sulle pull request verso quel branch.

​
Installazione

Per iniziare, segui i passaggi nella pagina GitHub. Per le GitHub App, puoi scegliere di concedere le autorizzazioni a un solo repository. Ti consigliamo vivamente di farlo, poiché ci serve accedere solo al repository in cui è ospitata la tua documentazione.

​
Configurazione

Configura i controlli CI abilitati per un deployment dalla pagina Add-ons della tua dashboard. Abilita i controlli che desideri eseguire. Quando abiliti i controlli, puoi scegliere di eseguirli con livello Warning o Blocking.
  • Un controllo con livello Warning non andrà mai in stato di errore, anche in presenza di errori o suggerimenti.
  • Un controllo con livello Blocking andrà in stato di errore se non viene superato o se vengono suggerite modifiche.

​
Verifiche CI disponibili

Analogamente a come il link checker della CLI funziona in locale, controlliamo automaticamente la tua documentazione per individuare link non funzionanti. Per vedere i risultati di questo controllo, visita la pagina dei risultati dei check di GitHub per un commit specifico.

​
Vale

Vale è un linter di prosa open source basato su regole che supporta vari formati di documenti, tra cui Markdown e MDX. Mintlify supporta l’esecuzione automatica di Vale in un controllo CI e la visualizzazione dei risultati come stato del controllo.

​
Configurazione

Se hai un file .vale.ini nella directory dei contenuti principale del tuo deployment, useremo automaticamente quel file di configurazione. Useremo automaticamente anche eventuali file di configurazione presenti nello stylesPath specificato. Se non disponi di un file di configurazione di Vale, verrà caricata la configurazione predefinita.
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
Tieni presente che, per motivi di sicurezza, non possiamo supportare uno stylesPath assoluto né uno stylesPath che includa valori ... Usa percorsi relativi e includi lo stylesPath nel tuo repository.

​
Pacchetti

Vale supporta una serie di pacchetti che possono essere usati per verificare ortografia e stile. Qualsiasi pacchetto incluso nel tuo repository nel stylesPath corretto viene installato e utilizzato automaticamente nella configurazione di Vale. Per i pacchetti non presenti nel repository, puoi indicare qualsiasi pacchetto dal registro dei pacchetti di Vale: verrà scaricato e usato automaticamente nella tua configurazione di Vale.
Tieni presente che, per motivi di sicurezza, non è possibile scaricare automaticamente pacchetti che non provengono dal registro dei pacchetti di Vale.

​
Vale con MDX

Vale non supporta nativamente MDX, ma l’autore di Vale ha fornito un’estensione personalizzata per abilitarne il supporto. Se preferisci non usare questa estensione, ti consigliamo di aggiungere le seguenti righe al file .vale.ini: 
[formats]
mdx = md

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

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

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
Per usare i commenti inline di Vale, utilizza i commenti in stile MDX {/* ... */}. Se imposti CommentDelimiters = {/*, */} nella configurazione, Vale interpreta automaticamente questi commenti durante il linting. In questo modo puoi usare facilmente le funzionalità integrate di Vale, come saltare righe o sezioni. 
{/* vale off */}

Questo testo verrà ignorato da Vale

{/* vale on */}
Se scegli di non usare CommentDelimiters ma vuoi comunque usare i commenti di Vale, devi racchiuderli in commenti MDX {/* ... */}. Ad esempio: 
{/* <!-- vale off --> */}

Questo testo verrà ignorato da Vale

{/* <!-- vale on --> */}
Questi tag di commento non sono supportati all’interno dei Componenti (Mintlify) ma possono essere utilizzati ovunque al livello base di un documento.