Passer au contenu principal
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 afficher des avertissements avant le déploiement. Les vérifications CI sont configurées pour s’exécuter sur les commits de votre branche de déploiement, ou sur les pull requests (demandes de fusion) ciblant cette branche.

​
Installation

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

​
Configuration

Configurez les vérifications CI activées pour un déploiement en accédant à la page Modules complémentaires de votre Dashboard. Activez les vérifications que vous souhaitez exécuter. Lors de l’activation des vérifications, vous pouvez choisir de les exécuter avec un niveau Warning ou Blocking.
  • Une vérification au niveau Warning n’indiquera jamais un statut d’échec, même en cas d’erreur ou de suggestions.
  • Une vérification au niveau Blocking indiquera un statut d’échec si elle n’est pas validée, ou si des modifications sont suggérées.

​
Vérifications CI disponibles

Comme pour le contrôle des liens via la CLI sur votre machine locale, nous vérifions automatiquement vos documents pour détecter les liens rompus. Pour consulter les résultats de ce contrôle, ouvrez la page des résultats des vérifications GitHub pour un commit spécifique.

​
Vale

Vale est un linter de prose open source basé sur des règles, compatible avec divers types de documents, notamment Markdown et MDX. Mintlify peut exécuter automatiquement Vale lors d’un contrôle CI et afficher les résultats comme statut 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 présents dans le stylesPath que vous avez indiqué. Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est chargée automatiquement.
Default vale.ini configuration
# Styles de niveau supérieur
StylesPath = /app/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

# Vocabulaires
Vocab = Mintlify

# Ceci est requis car Vale ne prend pas officiellement en charge MDX
[formats]
mdx = md

# Prise en charge MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Applique des règles de capitalisation très strictes, laisser désactivé

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

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

CommentDelimiters = {/*, */}
Default Vale vocabulary
Mintlify
mintlify
VSCode
openapi
OpenAPI
GitHub
API

repo
npm
dev

Lorem
ipsum
impsum
amet

const
myName
myObject
bearerAuth
favicon
topbar
url
borderRadius
args
modeToggle
ModeToggle
isHidden
autoplay

_italique_
Barré
Citations
Citation
Ligne unique
Multiligne

intégration

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
Interface en ligne de commande (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 (JSON Web Token)
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 accepter de stylesPath absolu, ni de stylesPath contenant « .. ». Utilisez des chemins relatifs et incluez le stylesPath dans votre référentiel.

​
Packages

Vale prend en charge une gamme de packages, qui peuvent être utilisés pour détecter les fautes d’orthographe et les erreurs de style. Tous les packages que vous incluez dans votre référentiel sous le stylesPath approprié sont automatiquement installés et utilisés dans votre configuration Vale. Pour les packages non inclus dans votre référentiel, vous pouvez spécifier n’importe quels packages depuis le registre de packages Vale ; ils sont alors automatiquement téléchargés et utilisés dans votre configuration Vale.

​
Vale avec MDX

Vale ne prend pas en charge MDX nativement, mais l’auteur de Vale a fourni une extension personnalisée pour l’activer. Si vous préférez ne pas utiliser cette extension, nous vous 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 in-document de Vale, utilisez des commentaires au format MDX {/* ... */}. Si vous définissez le paramètre CommentDelimiters = {/*, */} dans votre configuration, Vale interprétera automatiquement ces commentaires lors de l’analyse. Cela signifie que vous pouvez facilement tirer parti des fonctionnalités intégrées de Vale, comme ignorer des lignes ou des sections. Pour plus de détails, consultez le paramètre CommentDelimiters. 
{/* vale off */}

Ce texte sera ignoré par Vale

{/* vale on */}
Si vous choisissez de ne pas utiliser CommentDelimiters mais d’utiliser quand même les commentaires de Vale, vous devez envelopper tous les commentaires Vale dans des commentaires MDX {/* ... */}. Par exemple : 
{/* <!-- vale off --> */}

Ce texte sera ignoré par Vale

{/* <!-- vale on --> */}
Ces balises de commentaire ne sont pas prises en charge à l’intérieur des composants Mintlify, mais peuvent être utilisées n’importe où au niveau de base d’un document.
⌘I