Bien démarrer avec l’éditeur web

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

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

• Édition visuelle : Modifiez votre documentation avec un éditeur WYSIWYG (What You See Is What You Get) qui montre le rendu final de votre contenu.
• Synchronisation Git : Toutes les modifications sont automatiquement synchronisées avec votre référentiel Git pour maintenir le contrôle de version.
• Collaboration en équipe : Plusieurs personnes peuvent travailler simultanément sur la documentation.
• Intégration de composants : Ajoutez des encarts, des blocs de code et d’autres composants à l’aide de commandes slash.
• Aucune configuration requise : Commencez à écrire immédiatement depuis votre Dashboard.

​

Flux de travail de l’éditeur web

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

1. Choose your branch

   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. Open your file

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

3. Edit your content

   Apportez des modifications dans l’éditeur web. Essayez d’alterner entre le mode visuel et le Mode Markdown à l’aide du basculeur situé dans le coin supérieur droit pour voir quel mode vous préférez.

4. Preview your changes

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

5. Publish your changes

   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 (demande de fusion) 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 le commutateur dans l’angle supérieur droit de la barre d’outils de l’éditeur pour passer d’un mode à l’autre.

​

Mode visuel

Le mode visuel offre une expérience WYSIWYG (What You See Is What You Get) où les modifications que vous effectuez dans l’éditeur sont exactement celles qui seront publiées sur votre site de documentation. Ce mode est idéal pour prévisualiser en temps réel l’apparence de vos modifications.

Appuyez sur « / » pour ouvrir le menu des composants et ajouter du contenu mis en forme, 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 en syntaxe Markdown.

​

Prochaines étapes

• Apprenez les concepts Git fondamentaux.
• Découvrez les meilleures pratiques de collaboration via les branches.
• Explorez la gestion du contenu avec l’éditeur web.
• Comprenez les options de publication selon différents cas d’usage.