Skip to main content

Vous découvrez l'éditeur ? Commencez par le tutoriel.

Créez une branch, faites une modification, partagez un aperçu et publiez.
Utilisez l’éditeur pour rédiger et publier de la documentation dans votre navigateur. L’éditeur repose sur un workflow docs-as-code dans lequel Git conserve toutes vos modifications. Votre travail est enregistré sous forme de commits dans votre dépôt et l’éditeur gère les opérations Git à votre place. L’éditeur se charge par défaut lorsque vous ouvrez votre dashboard. Tout membre de votre organisation peut l’ouvrir, mais certaines actions dépendent de votre rôle. Les admins et les editors peuvent modifier et publier. Les viewers peuvent parcourir le contenu et laisser des commentaires et des suggestions.

​
Fonctionnement de l’éditeur

Les modifications sont enregistrées automatiquement, mais enregistrer n’est pas publier. Au fur et à mesure que vous écrivez, l’éditeur enregistre votre travail. Vos modifications persistent d’un onglet, d’un appareil et d’une coupure réseau à l’autre. Pour qu’une modification atteigne votre site publié, vous devez la publier. Publier écrit dans Git. Lorsque vous publiez, l’éditeur commit vos modifications dans votre dépôt. Si vous publiez sur votre deployment branch, votre site publié est mis à jour immédiatement. Sur une feature branch, vous pouvez enregistrer vos modifications sur la branch ou ouvrir une pull request pour révision. Rien sur une feature branch n’atteint votre site publié tant qu’elle n’est pas fusionnée dans votre deployment branch. Git reste synchronisé. Lorsque quelqu’un pousse des modifications vers votre dépôt, elles apparaissent automatiquement. Vous n’avez pas besoin de faire un pull ni d’actualiser. L’éditeur fusionne les modifications sans conflit et signale tout ce qui requiert votre attention. Votre équipe travaille ensemble. Plusieurs personnes peuvent modifier la même page en même temps, avec des curseurs en direct qui montrent qui travaille où. Les commentaires et les suggestions sont visibles par tous.
Si l’éditeur semble désynchronisé par rapport à votre dépôt, utilisez Réinitialiser l’éditeur pour forcer une resynchronisation.

​
Disposition de l’éditeur

  • Barre supérieure : Utilisez la barre supérieure pour choisir la branch sur laquelle vous travaillez, accéder à l’agent, prévisualiser et publier vos modifications.
  • Barre latérale : Utilisez la barre latérale pour sélectionner les pages à modifier, créer de nouvelles pages et gérer la structure de votre site.
    • Home : L’arborescence de fichiers de votre projet. Les pages dans Personal vous sont privées. Les pages dans Workspace sont publiques pour votre organisation.
    • Publishing : La structure de navigation de votre site. Organisez les pages telles que vous voulez qu’elles apparaissent sur votre site.

​
Mode visuel et mode source

Le mode visuel affiche votre page au fur et à mesure que vous écrivez. Appuyez sur / pour ouvrir le menu des composants et en insérer. Le mode source vous donne un accès direct au MDX. Utilisez-le pour contrôler précisément les propriétés des composants et le frontmatter. Les deux modes modifient le même fichier. Passez de l’un à l’autre avec Cmd + Shift + S (macOS) ou Ctrl + Shift + S (Windows). Pour connaître les composants que vous pouvez insérer, consultez Composants. Pour la syntaxe MDX, consultez Mettre en forme le texte et Mettre en forme le code.

​
Notions de Git

Comprendre quelques notions de Git vous aide à tirer le meilleur parti de l’éditeur. Pour les définitions des commits, branches, pull requests, merges, conflits et diffs, consultez Concepts de Git pour la documentation.

Sujets connexes

Paramètres de l'éditeur pour l'IA et la publicationBranche absente de la liste des branches de l'éditeur webServeur Admin Model Context Protocol (MCP)