Utilisez les vérifications CI pour analyser votre documentation, détecter les erreurs et émettre des avertissements avant le déploiement. Elles sont configurées pour s’exécuter lors des commits sur votre branche de déploiement configurée, ou sur les pull requests ciblant cette branche.
Pour commencer, suivez les étapes de la page GitHub.
Pour les applications GitHub, vous pouvez choisir de n’accorder des autorisations qu’à un seul dépôt. Nous le recommandons vivement, car nous n’avons besoin d’accéder qu’au dépôt où votre documentation est hébergée.
Configurez les contrôles CI à activer pour un déploiement en vous rendant sur 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 avec un niveau Warning ou Blocking.
- Un contrôle de niveau
Warning n’indiquera jamais un état d’échec, même en cas d’erreur ou de suggestions.
- Un contrôle de niveau
Blocking indiquera un état d’échec s’il n’est pas réussi ou si des modifications sont suggérées.
Comme le vérificateur de liens de la CLI sur votre machine locale, nous vérifions automatiquement vos docs pour détecter les liens brisés.
Pour consulter les résultats de ce contrôle, rendez-vous sur la page des résultats de vérification de GitHub pour un commit donné.
Vale est un linter de prose open source, basé sur des règles, qui prend en charge une variété de types de documents, dont Markdown et MDX.
Mintlify peut exécuter automatiquement Vale dans un contrôle CI et afficher les résultats sous forme de statut de vérification.
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 spécifié.
Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est chargée automatiquement.
Configuration vale.ini par défaut développable
# Styles de niveau supérieur
StylesPath = /app/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code
# Vocabularies
Vocab = Mintlify
# Nécessaire, car Vale ne prend pas officiellement en charge MDX
[formats]
mdx = md
# Prise en charge de MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Implique 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 = {/*, */}
Vocabulaire Vale par défaut extensible
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_
Barré
Bloc de citation
Bloc de citation
Une seule ligne
Multiligne
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 des raisons de sécurité, nous ne prenons pas en charge un stylesPath absolu ni un stylesPath contenant des valeurs ... Utilisez des chemins relatifs et incluez le stylesPath dans votre dépôt.
stylesPath approprié sont automatiquement installés et utilisés dans votre configuration Vale.
Pour les packages qui ne sont pas inclus dans votre dépôt, vous pouvez spécifier n’importe quel package depuis le registre de packages Vale ; ils seront automatiquement téléchargés et utilisés dans votre configuration Vale.
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. MDX, 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 dans 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)^({.+.*})
{/* ... */}. Si vous activez le paramètre CommentDelimiters = {/*, */} dans votre configuration, Vale interprétera automatiquement ces commentaires lors de l’analyse (linting). Vous pouvez ainsi facilement profiter des fonctionnalités natives de Vale, comme ignorer des lignes ou des sections.
{/* vale off */}
Ce texte sera ignoré par Vale
{/* vale on */}
CommentDelimiters mais souhaitez tout de même utiliser les commentaires de Vale, vous devez envelopper tout commentaire Vale dans des commentaires MDX {/* ... */}. Par exemple :
{/* <!-- vale off --> */}
Ce texte sera ignoré par Vale
{/* <!-- vale on --> */}
