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 lors des commits sur votre branche de déploiement configurée, ou sur les pull requests (demandes de fusion) visant cette branche.
Pour commencer, suivez les étapes sur la page GitHub.Pour 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.
Configurez les contrôles CI activés pour un déploiement en vous rendant sur 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 avec un niveau Avertissement ou Bloquant.
Un contrôle de niveau Avertissement n’affichera jamais un statut d’échec, même en cas d’erreur ou de suggestions.
Un contrôle de niveau Bloquant affichera un statut d’échec s’il n’est pas réussi ou si des modifications sont suggérées.
Comme le vérificateur de liens de l’interface en ligne de commande (CLI) sur votre machine locale, nous vérifions automatiquement vos docs pour détecter les liens rompus.Pour consulter les résultats de cette vérification, rendez-vous sur la page des résultats de vérification GitHub du commit concerné.
Vale est un linter de prose open source, basé sur des règles, qui prend en charge un large éventail de types de documents, notamment Markdown et MDX.Mintlify permet d’exécuter automatiquement Vale dans une vérification CI et d’afficher les résultats en tant que 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 tout fichier de configuration présent 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
# Styles de niveau supérieurStylesPath = /app/stylesMinAlertLevel = suggestionIgnoredScopes = code, tt, img, url, aSkippedScopes = script, style, pre, figure, code# VocabulairesVocab = Mintlify# Ceci est requis car Vale ne prend pas officiellement en charge MDX[formats]mdx = md# Prise en charge MDX[*.mdx]BasedOnStyles = ValeVale.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
MintlifymintlifyVSCodeopenapiOpenAPIGithubAPIreponpmdevLoremipsumimpsumametconstmyNamemyObjectbearerAuthfavicontopbarurlborderRadiusargsmodeToggleModeToggleisHiddenautoplay_italique_Texte barréCitationsCitationLigne uniqueMultiligneintégrationasyncawaitbooleanenumfuncimplinitinstanceoftypeofparamsstdinstdoutstderrstdoutstdinvarconstletnullundefinedstructboolcorscsrfenvxhrxhr2JWTOAuthwebsocketlocalhostmiddlewareruntimewebhookstdinstdoutjsonyamlymlmdtxttsxjsxcssscsshtmlpngjpgsvgcdnInterface en ligne de commande (CLI)cssdomdtoenvGitguihttphttpsidejvmmvcormrpcSDKsqlsshssltcptlsuriURLuxuinodejsnpmyarnpnpmeslintpytestgolangrustckubectlmongopostgresredisJavaScriptTypeScriptPythonRubyRustGoGolangJavaKotlinSwiftNode.jsNodeJSDenoReactVueAngularNext.jsNuxtExpressDjangoFlaskSpringLaravelReduxVuexTensorFlowPostgreSQLMongoDBRedisPNPMDockerKubernetesAWSAzureGCPTerraformJenkinsCircleCIGitLabHerokuGitgitGitHubGitLabBitbucketVSCodeVisual Studio CodeIntelliJWebStormESLinteslintPrettierprettierWebpackwebpackViteviteBabelbabelJestjestMochaCypressPostmanHTTPHTTPSOAuthJWTGraphQLRESTWebSocketTCP/IPNPMYarnPNPMPipPIPCargoRubyGemsSwaggerOpenAPIMarkdownMDXStorybookTypeDocJSDocMySQLPostgreSQLMongoDBRedisElasticsearchDynamoDBLinuxUnixmacOSiOSFirefoxChromiumWebKitconfigctxdescdirelemerrlenmsgnumobjprevprocptrreqresstrtmpvalvarstodohreflangnavprevnexttoc
Vale prend en charge un éventail de paquets, qui peuvent servir à vérifier l’orthographe et le style.
Tous les paquets que vous placez dans votre référentiel sous le stylesPath approprié sont automatiquement installés et utilisés dans votre configuration Vale.Pour les paquets qui ne sont pas dans votre référentiel, vous pouvez indiquer n’importe quels paquets du registre de paquets Vale ; ils seront automatiquement téléchargés et utilisés dans votre configuration Vale.
Vale ne prend pas en charge nativement 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 à votre fichier .vale.ini :
Pour utiliser les commentaires dans le document de Vale, utilisez des commentaires au format MDX {/* ... */}. Si vous utilisez le paramètreCommentDelimiters = {/*, */} dans votre configuration, Vale interprétera automatiquement ces commentaires lors de l’analyse (linting). Cela signifie que vous pouvez facilement utiliser les fonctionnalités 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 mais d’utiliser tout de même les commentaires de Vale, vous devez envelopper chaque commentaire 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 dans les composants Mintlify, mais peuvent être utilisées partout au niveau de base d’un document.
