Premiers pas avec l’éditeur web

Apprenez à créer et à modifier la documentation avec l’éditeur web

L’éditeur web est une interface visuelle pour créer, modifier et relire la documentation directement dans votre navigateur.

• Édition visuelle : Modifiez votre documentation avec un éditeur WYSIWYG (what you see is what you get) qui affiche le rendu final de votre contenu.
• Synchronisation Git : Toutes les modifications sont automatiquement synchronisées avec votre dépôt Git pour conserver l’historique des versions.
• Collaboration d’équipe : Plusieurs personnes peuvent travailler simultanément sur la documentation.
• Intégration de composants : Ajoutez des encadrés, des blocs de code et d’autres composants via des commandes « slash ».
• Aucune configuration requise : Commencez à écrire immédiatement depuis votre tableau de bord.

Flux de travail de l’Éditeur web

Voici comment vous travaillerez généralement dans l’Éditeur web :

1. Choisissez votre branche

   Créez une branche ou apportez des modifications directement à votre branche de déploiement. Nous recommandons de créer une branche afin de pouvoir prévisualiser vos modifications avant leur mise en ligne.

2. Ouvrez votre fichier

   Accédez à un fichier existant dans la barre latérale ou créez-en un nouveau à l’aide de l’explorateur de fichiers.

3. Modifiez votre contenu

   Modifiez votre contenu dans l’Éditeur web. Essayez d’alterner entre le mode visuel et le mode Markdown à l’aide de l’interrupteur dans le coin supérieur droit pour voir lequel vous préférez.

4. Prévisualisez vos modifications

   Le mode visuel montre comment vos modifications apparaîtront sur votre site en production. Utilisez-le pour vérifier que tout est correct.

5. Publiez vos modifications

   Si vous travaillez sur votre branche de déploiement, publiez vos modifications directement depuis l’Éditeur web. Sur les autres branches, créez une pull request pour relecture avant la publication.

Modes de l’éditeur

L’Éditeur web propose deux modes pour s’adapter à différentes préférences et besoins d’édition. Utilisez l’interrupteur dans l’angle supérieur droit de la barre d’outils de l’éditeur pour basculer entre les modes.

Mode visuel

Le mode visuel offre une expérience WYSIWYG où les modifications effectuées dans l’éditeur sont exactement celles qui seront publiées sur votre site de documentation. Ce mode est idéal pour visualiser vos changements en temps réel.

Appuyez sur « / » pour ouvrir le menu des composants et ajouter du contenu stylé, des encadrés, des extraits de code ou d’autres composants.

Mode Markdown

Le mode Markdown donne un accès direct au code MDX sous-jacent de votre documentation. Ce mode est idéal lorsque vous avez besoin d’un contrôle précis des propriétés des composants ou lorsque vous préférez écrire avec la syntaxe Markdown.

Prochaines étapes

• Apprenez les concepts fondamentaux de Git.
• Découvrez les meilleures pratiques de collaboration avec les branches.
• Explorez la gestion de contenu avec l’Éditeur web.
• Familiarisez-vous avec les options de publication adaptées à différents scénarios.