Comment utiliser l'éditeur
Tutoriel pas à pas de l'éditeur Mintlify : créez une branch, modifiez des pages, partagez un déploiement de prévisualisation pour révision et publiez vos modifications.
Ce tutoriel vous guide à travers une mise à jour de contenu complète avec l’éditeur. Vous allez créer une branch, faire une modification, partager un aperçu pour révision et publier vos modifications.
Créer une branch
Une branch est une copie temporaire de votre contenu. C’est là que vous effectuez vos modifications sans affecter votre site publié. Vous pouvez fusionner une branch dans votre site publié ou l’abandonner en toute sécurité si vous choisissez de ne pas appliquer les modifications.
Travailler sur une branch permet de garder vos modifications séparées de votre site publié jusqu’à ce que vous soyez prêt à partager le contenu avec vos utilisateurs.
- Dans la barre d’outils de l’éditeur, cliquez sur le nom de la branch (généralement
main, avec un badge Live). Si vous ne le voyez pas, affichez le sélecteur de branch. - Dans Find a branch, saisissez un titre qui décrit votre modification, comme
Update quickstart. - Cliquez sur New branch.
L’éditeur bascule vers votre nouvelle branch. Toutes les modifications que vous effectuez ne sont présentes que sur la branch, et elles sont commitées automatiquement sur la branch pendant que vous travaillez. Elles n’apparaissent sur votre site publié que si vous terminez le processus de publication.
Effectuer vos modifications
Modifiez une page existante ou créez-en une nouvelle.
Pour modifier une page : Cliquez sur le nom de la page dans la barre latérale de navigation pour l’ouvrir. Tapez directement dans l’éditeur pour ajouter du contenu. Appuyez sur / pour insérer des composants, des images ou d’autres contenus.
Pour créer une page : Cliquez sur le bouton plus à côté du group de navigation où vous souhaitez ajouter la page, puis cliquez sur New page. Saisissez un titre pour la page. L’éditeur nomme le fichier d’après le titre.
Publier votre branch
Lorsque vous modifiez une branch pour la première fois, l’éditeur ouvre une pull request pour elle. Une pull request est une proposition visant à fusionner vos modifications dans la branch qui compile votre site publié. Vos modifications ne sont mises en ligne qu’une fois la pull request fusionnée.
Lorsque vous êtes prêt pour la révision, demandez-la depuis le menu de publication.
- Cliquez sur Publish dans la barre d’outils pour ouvrir le menu de publication.
- Vous pouvez cliquer sur n’importe quel fichier modifié de la liste pour consulter et comparer vos modifications à la version publiée.
- Cliquez sur Request review.
Un déploiement de prévisualisation est compilé pour votre pull request : un lien temporaire où vos modifications s’affichent exactement comme elles apparaîtraient sur votre site publié. Retrouvez l’URL dans le commentaire de pull request du bot Mintlify, et partagez-la avec vos relecteurs.
Faire approuver votre pull request
Partagez la pull request avec votre équipe. Pour l’ouvrir, cliquez sur View request dans le menu de publication. Les relecteurs peuvent ouvrir la pull request dans GitHub, GitLab ou Bitbucket pour laisser des commentaires, demander des modifications ou l’approuver.
Si un relecteur demande des modifications, effectuez-les dans l’éditeur sur la même branch. Vos mises à jour sont commitées automatiquement dans la pull request existante. Vous n’avez pas besoin d’en créer une nouvelle.
Une fois que tous les relecteurs requis ont approuvé, la pull request est prête à être fusionnée.
Fusionner et publier
Une fois la pull request approuvée, cliquez sur Publish dans la barre d’outils pour rouvrir le menu de publication. Le menu affiche désormais l’état de la pull request et une option pour fusionner.
Cliquez sur Merge and publish. Si Mintlify héberge votre dépôt et qu’aucune approbation n’est requise, le bouton s’appelle Publish à la place. L’éditeur fusionne la pull request et vous ramène sur votre deployment branch. Mintlify compile et déploie vos modifications. Votre site publié se met à jour en environ 30 secondes à quelques minutes.