Passer au contenu principal
Les offres Pro et Custom 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 signaler des avertissements avant le déploiement. Les vérifications CI de Mintlify s’exécutent sur les pull requests (demandes de fusion) visant une branche de déploiement configurée.

​
Installation

Pour commencer, suivez les étapes indiquées sur la page GitHub.
Seul l’accès au référentiel où se trouve le contenu de votre documentation est requis ; il est donc fortement recommandé de n’accorder l’accès qu’à ce référentiel.

​
Configuration

Configurez les contrôles CI activés pour un déploiement en accédant à la page Modules complémentaires de votre Dashboard. 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 Avertissement ou Bloquant.
  • Un contrôle de niveau Avertissement n’indiquera jamais un statut d’échec, même en cas d’erreur ou de suggestions.
  • Un contrôle de niveau Bloquant indiquera un statut d’échec en cas d’erreur ou de suggestions.

​
Vérifications CI disponibles

Comme le vérificateur de liens de l’interface en ligne de commande (CLI) sur votre machine locale, la vérification CI des liens cassés recherche automatiquement les liens internes cassés dans le contenu de votre documentation. Pour consulter les résultats de cette vérification, rendez-vous sur 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 qui prend en charge un large éventail de types de documents, y compris Markdown et MDX. Utilisez Vale pour vérifier la cohérence du style et du ton de votre documentation. Mintlify permet d’exécuter automatiquement Vale dans un contrôle CI et d’afficher les résultats comme statut de contrôle.

​
Configuration

Si vous avez un fichier .vale.ini à la racine du répertoire de contenu de votre déploiement, la vérification Vale CI utilise ce fichier de configuration ainsi que tous les fichiers de configuration présents dans le stylesPath que vous avez spécifié. Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est automatiquement chargée.
Default vale.ini configuration
# Styles de niveau supérieur
StylesPath = /app/styles
MinAlertLevel = suggestion
# Balises HTML en ligne à ignorer (code/tt pour les extraits de code, img/url pour les liens/images, a pour les balises d'ancrage)
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure

# Vocabulaires
Vocab = Mintlify

# Packages
Packages = MDX

# Correspondre uniquement aux fichiers MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Applique des règles de capitalisation très strictes, laisser désactivé

# Ignorer les motifs de syntaxe spécifiques à JSX/MDX
# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Exclure le JSX multiligne et les accolades
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
Le vocabulaire par défaut de Vale comprend les mots suivants.
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
Pour ajouter votre propre vocabulaire à la configuration par défaut, créez un répertoire styles/config/vocabularies/Mintlify contenant les fichiers accept.txt et reject.txt.
  • accept.txt : Mots à ignorer par le linter Vale. Par exemple, des noms de produits ou des termes peu courants.
  • reject.txt : Mots qui doivent être signalés comme des erreurs. Par exemple, du jargon ou des mots qui ne sont pas appropriés au ton de votre documentation.
Example Vale file structure
/votre-projet
  |- docs.json
  |- .vale.ini
  |- styles/
    |- config/
      |- vocabularies/
        |- Mintlify/
          |- accept.txt
          |- reject.txt
  |- page-exemple.mdx
Example monorepo Vale file structure
/your-monorepo
  |- main.ts
  |- docs/
    |- docs.json
    |- .vale.ini
    |- styles/
      |- config/
      |- vocabularies/
        |- Mintlify/
          |- accept.txt
          |- reject.txt
    |- example-page.mdx
  |- test/
Pour des raisons de sécurité, les stylesPath absolus ou les stylesPath contenant .. ne sont pas pris en charge.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 ajoutez à votre référentiel sous le stylesPath approprié sont automatiquement installés et utilisés dans votre configuration Vale. Pour les packages qui ne sont pas inclus dans votre référentiel, vous pouvez spécifier n’importe quel package du registre de packages Vale, qui sera automatiquement téléchargé et utilisé dans votre configuration Vale.
Pour des raisons de sécurité, le téléchargement automatique de packages qui ne proviennent pas du registre de packages Vale n’est pas pris en charge.

​
Vale avec MDX

La prise en charge native de MDX nécessite Vale 3.10.0 ou une version ultérieure. Vérifiez votre version de Vale avec vale --version.
Pour utiliser les commentaires intégrés de Vale dans les fichiers MDX, utilisez les commentaires au format MDX {/* ... */} : 
{/* vale off */}

Ce texte est ignoré par Vale

{/* vale on */}
Vale reconnaît et respecte automatiquement ces commentaires dans les fichiers MDX sans configuration supplémentaire. Utilisez les commentaires pour ignorer les lignes ou sections qui doivent être ignorées par le linter.