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
Vocabulaire Vale par défaut extensible
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 :
Pour utiliser les commentaires in-doc de Vale, utilisez des commentaires au format MDX {/* ... */}. 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.
Si vous choisissez de ne pas utiliser CommentDelimiters mais souhaitez tout de même utiliser les commentaires de Vale, vous devez envelopper tout commentaire Vale dans des commentaires MDX {/* ... */}. Par exemple :
Ces balises de commentaire ne sont pas prises en charge à l’intérieur des composants Mintlify, mais peuvent être utilisées partout au niveau racine d’un document. 
