Démarrage rapide - Mintlify

Après avoir terminé ce guide, vous disposerez d’un site de documentation en ligne prêt à être personnalisé et mis à jour.

Mintlify utilise une approche docs-as-code pour gérer votre documentation. Chaque page de votre site possède un fichier correspondant, stocké dans votre de documentation. Lorsque vous connectez votre référentiel de documentation à votre projet, vous pouvez travailler sur votre documentation localement ou dans l’éditeur web et synchroniser toutes les modifications avec votre référentiel distant.

Accédez à mintlify.com/start et suivez le processus d’onboarding. Pendant l’onboarding, vous connectez votre compte GitHub, créez ou sélectionnez un référentiel pour votre documentation et installez la GitHub App afin d’activer les déploiements automatiques. Après l’onboarding, votre site de documentation est déployé et accessible via l’URL .mintlify.app de votre site.

Votre site de documentation est maintenant déployé à l’adresse https://<your-project-name>.mintlify.app. Trouvez l’URL exacte de votre site sur la page Overview de votre Tableau de bord Mintlify.

Utiliser l’éditeur web

Modifiez la documentation dans votre navigateur et prévisualisez l’apparence de vos pages une fois publiées.

Explorer les commandes CLI

Repérez les liens brisés, vérifiez l’accessibilité, validez les spécifications OpenAPI et bien plus encore.

Ajouter un domaine personnalisé

Utilisez votre propre domaine pour votre site de documentation.