Passer au contenu principal

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, vos modifications sont commitées automatiquement sur la branch et ouvrent 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 : Cliquez sur Collapse sidebar pour masquer vos pages, et sur Ask agent pour ouvrir l’agent à côté de votre page. Sur une page du site, la barre supérieure comporte également Preview et Publish, ainsi que le sélecteur de branch lorsqu’il est visible. Sur une page privée, elle comporte Share. Cliquez sur More options pour les actions de page comme Page settings, Comments, Version history, Duplicate et Move within project.
  • Barre latérale : Utilisez la barre latérale pour sélectionner les pages à modifier, créer de nouvelles pages, gérer la structure de votre site et naviguer dans le dashboard. Appuyez sur Cmd + \ (macOS) ou Ctrl + \ (Windows) pour masquer ou afficher vos pages. Appuyez sur Cmd + K (macOS) ou Ctrl + K (Windows) pour rechercher dans le dashboard.
    • Icônes du dashboard : Changez de projet depuis le menu en haut. Cliquez sur Home pour revenir à l’éditeur depuis n’importe où dans le dashboard, ou sur Search pour rechercher dans vos pages, vos paramètres et vos automatisations. En dessous, ouvrez Publishes, Analytics, Automations, MCP et Settings. En bas, cliquez sur Get help pour accéder à la documentation, à l’assistance et aux nouveautés du produit, ou cliquez sur votre avatar pour ouvrir le menu de votre profil.
    • Pages : Navigation contient les pages présentes dans la navigation de votre site. Files liste les fichiers de votre dépôt qui ne figurent pas dans votre navigation. Si vous utilisez des pages privées, Personal contient vos brouillons privés et Shared with me contient les pages que des collègues vous ont partagées directement.

​
Rechercher dans le dashboard

Appuyez sur Cmd + K (macOS) ou Ctrl + K (Windows), ou cliquez sur Search dans la barre latérale, pour rechercher dans le dashboard. En mode visuel, désélectionnez d’abord tout texte, car Cmd + K ajoute un lien au texte sélectionné. La recherche trouve :
  • Vos pages.
  • Les pages de paramètres.
  • Les sections de docs.json, qui s’ouvrent dans l’éditeur.
  • Les sections Analytics et Publishes.
  • Les automatisations, par nom.
La recherche exécute aussi des actions, comme inviter des membres, créer une automatisation, ouvrir ou fermer l’agent, afficher ou masquer la barre latérale, basculer entre les thèmes clair et sombre, contacter l’assistance et ouvrir la liste des raccourcis clavier. Certaines actions, comme inviter des membres, n’apparaissent que si votre rôle les autorise. Avant que vous ne tapiez quoi que ce soit, la recherche suggère des résultats pour la page sur laquelle vous vous trouvez. Par exemple, sur une page de paramètres, elle suggère des sections de cette page, et dans l’éditeur, elle suggère des sections de la configuration du 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, avec des numéros de ligne. Utilisez-le pour contrôler précisément les propriétés des composants et le frontmatter. Saisissez < pour accéder aux composants. Appuyez sur Cmd + S (macOS) ou Ctrl + S (Windows) pour formater le document. Si une modification unique change plus de 10 000 caractères, l’éditeur vous demande de la confirmer. Les deux modes modifient le même fichier et prennent en charge l’édition en temps réel. Passez de l’un à l’autre avec Cmd + Shift + S (macOS) ou Ctrl + Shift + S (Windows), ou avec le bouton Source mode dans More options. L’éditeur mémorise votre choix d’une page à l’autre. Le mode source n’est pas disponible lorsque le mode suggestion est activé. 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.