Passer au contenu principal

​
Configurez votre environnement de développement

Apprenez à mettre à jour votre documentation localement et à la déployer publiquement.

​
Modifier et prévisualiser

Pendant le processus d’intégration, nous avons créé un dépôt sur votre Github avec le contenu de votre documentation. Vous pouvez trouver ce dépôt sur notre tableau de bord. Pour cloner le dépôt localement, suivez ces instructions dans votre terminal.
La prévisualisation vous aide à vous assurer que vos modifications apparaissent comme prévu. Nous avons créé une interface en ligne de commande pour afficher ces changements localement. 1. Installez le CLI Mintlify pour prévisualiser les changements de documentation localement avec cette commande : npm i -g mintlify 2. Exécutez la commande suivante à la racine de votre documentation (où se trouve mint.json) : mintlify dev

​
Déployez vos modifications

Notre application Github déploie automatiquement vos modifications sur votre site de documentation, vous n’avez donc pas à gérer les déploiements vous-même. Vous pouvez trouver le lien d’installation sur votre tableau de bord. Une fois le bot installé avec succès, il devrait y avoir une coche à côté du hash de commit du dépôt.
Committez et poussez vos modifications vers Git pour que vos changements soient mis à jour sur votre site de documentation. Si vous poussez et ne voyez pas que l’application Github a déployé vos modifications avec succès, vous pouvez également mettre à jour manuellement votre documentation via notre tableau de bord.

​
Mettez à jour votre documentation

Ajoutez du contenu directement dans vos fichiers avec la syntaxe MDX et les composants React. Vous pouvez utiliser n’importe lequel de nos composants, ou même créer les vôtres.

Stylisez Votre Documentation

Ajoutez de la personnalité à votre documentation avec une image de marque personnalisée.

Ajoutez des Points d'Accès API

Implémentez votre spécification OpenAPI et activez l’interaction des utilisateurs avec l’API.

Intégrez l'Analytique

Tirez des insights des interactions des utilisateurs avec votre documentation.

Hébergez sur un Domaine Personnalisé

Gardez votre documentation sur le sous-domaine de votre propre site web.