Les offres Pro et Enterprise incluent des vérifications CI pour les dépôts GitHub.
Utilisez les vérifications CI pour analyser votre documentation, détecter les erreurs et générer des avertissements avant le déploiement. Les vérifications CI sont configurées pour s’exécuter lors des commits sur votre branche de déploiement configurée, ou sur les pull requests visant cette branche.

​
Installation

Pour commencer, suivez les étapes indiquées sur la page GitHub. Pour les applications GitHub, vous pouvez choisir de n’accorder des autorisations qu’à un seul dépôt. Nous vous le recommandons vivement, car nous n’avons besoin d’accéder qu’au dépôt où votre documentation est hébergée.

​
Configuration

Configurez les contrôles CI activés pour un déploiement en accédant à la page Add-ons de votre tableau de bord. Activez les contrôles que vous souhaitez exécuter. Lors de l’activation des contrôles, vous pouvez choisir de les exécuter au niveau Warning ou Blocking.
  • Un contrôle de niveau Warning n’affichera jamais un statut d’échec, même en cas d’erreur ou de suggestions.
  • Un contrôle de niveau Blocking affichera un statut d’échec s’il n’est pas réussi ou si des modifications sont suggérées.

​
Vérifications CI disponibles

À l’instar du vérificateur de liens de la CLI sur votre machine locale, nous vérifions automatiquement votre documentation pour détecter les liens cassés. Pour consulter les résultats de cette vérification, rendez-vous sur la page des vérifications GitHub du commit concerné.

​
Vale

Vale est un linter de prose open source, basé sur des règles, qui prend en charge plusieurs types de documents, dont Markdown et MDX. Mintlify permet d’exécuter automatiquement Vale dans une étape de CI et d’afficher les résultats sous forme d’état de vérification.

​
Configuration

Si vous avez un fichier .vale.ini à la racine du répertoire de contenu de votre déploiement, nous utilisons automatiquement ce fichier de configuration. Nous utilisons également automatiquement tous les fichiers de configuration situés dans le stylesPath que vous avez spécifié. Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est chargée automatiquement.
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
Veuillez noter que, pour des raisons de sécurité, nous ne pouvons pas prendre en charge un stylesPath absolu ni un stylesPath contenant des valeurs ... Utilisez des chemins relatifs et incluez le stylesPath dans votre dépôt.

​
Packages

Vale prend en charge une gamme de packages, qui peuvent être utilisés pour détecter les erreurs d’orthographe et de style. Tous les packages que vous ajoutez à votre dépôt sous le stylesPath approprié sont automatiquement installés et utilisés dans votre configuration Vale. Pour les packages non présents dans votre dépôt, vous pouvez spécifier n’importe quels packages issus du registre de packages Vale ; ils seront automatiquement téléchargés et utilisés dans votre configuration Vale.
Veuillez noter que, pour des raisons de sécurité, nous ne prenons pas en charge le téléchargement automatique de packages qui ne proviennent pas du registre de packages Vale.

​
Vale avec MDX

Vale ne prend pas en charge MDX de façon native, mais l’auteur de Vale a fourni une extension personnalisée pour l’ajouter. Si vous préférez ne pas utiliser cette extension, nous recommandons d’ajouter les lignes suivantes à votre fichier .vale.ini : 
[formats]
mdx = md

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

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

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
Pour utiliser les commentaires intégrés de Vale, utilisez les commentaires au format MDX {/* ... */}. Si vous utilisez le paramètre CommentDelimiters = {/*, */} dans votre configuration, Vale interprète automatiquement ces commentaires lors du linting. Vous pouvez ainsi utiliser facilement les fonctions intégrées de Vale, comme ignorer des lignes ou des sections. 
{/* vale off */}

Ce texte sera ignoré par Vale

{/* vale on */}
Si vous choisissez de ne pas utiliser CommentDelimiters tout en utilisant les commentaires de Vale, vous devez encapsuler chaque commentaire Vale dans un commentaire MDX {/* ... */}. Par exemple : 
{/* <!-- vale off --> */}

Ce texte sera ignoré par Vale

{/* <!-- vale on --> */}
Ces balises de commentaire ne sont pas prises en charge dans les Composants (Mintlify), mais peuvent être utilisées partout au niveau de base d’un document.