Passer au contenu principal
Parcourez vos pages de documentation dans l’onglet Navigation du panneau latéral gauche.
  • Cliquez sur les éléments de navigation pour les développer ou les réduire.
  • Cliquez sur les pages pour les ouvrir dans l’éditeur.
  • Cliquez sur l’icône de recherche ou appuyez sur Cmd + P (macOS) ou Ctrl + P (Windows) pour rechercher des fichiers par nom de fichier. La recherche effectue une correspondance exacte sur les noms de fichiers, utilisez donc des tirets entre les mots (par exemple, get-agent-job plutôt que get agent job).

​
Afficher les pages inutilisées

La section Pages inutilisées en bas de la section Settings de la barre latérale affiche les pages et autres fichiers qui existent dans votre référentiel mais ne sont pas incluses dans votre navigation. Il s’agit de pages cachées qui n’apparaissent pas sur votre site publié tant que vous ne les ajoutez pas à la navigation.

​
Créer de nouvelles pages

  1. Cliquez sur le bouton + dans l’élément de navigation où vous souhaitez ajouter une page.
  2. Cliquez sur Ajouter une page.
  3. Saisissez un nom de fichier. L’éditeur ajoute automatiquement l’extension .mdx.

​
Ajouter des pages inutilisées à la navigation

Ajoutez des pages à partir de la section Unused pages à votre navigation. Glisser-déposer :
  1. Recherchez la page dans la section Unused pages.
  2. Faites glisser la page vers l’emplacement souhaité dans votre arborescence de navigation.
Dans l’arborescence de navigation :
  1. Cliquez sur le bouton plus, , à l’endroit où vous souhaitez ajouter le fichier.
  2. Cliquez sur Add existing file.
  3. Sélectionnez la page que vous souhaitez ajouter.

​
Modifier le contenu

Basculez entre le mode visuel et le Markdown mode à l’aide du bouton de bascule dans la barre d’outils. L’éditeur web enregistre vos modifications lors du changement de mode.
Bouton de bascule de mode dans la barre d’outils.

​
Mode visuel

Modifiez le contenu avec des aperçus en temps réel qui montrent à quoi il ressemblera une fois publié.
  • Ajouter du texte : Saisissez du texte dans l’éditeur pour voir comment il apparaîtra une fois publié.
  • Mettre le texte en forme : Utilisez la barre d’outils pour mettre le texte en gras, en italique ou appliquer d’autres styles de mise en forme.
  • Ajouter des composants : Appuyez sur / pour ouvrir le menu des composants et sélectionner des composants.
  • Ajouter des images : Utilisez le composant d’image depuis le menu /.
  • Insérer des liens : Sélectionnez du texte et appuyez sur Cmd + K.
Voir Composants pour la liste complète des composants disponibles.

​
Mode Markdown

Modifiez le code source MDX.
  • Édition directe en MDX : Écrivez en syntaxe MDX et Markdown pour un contrôle précis du contenu.
  • Propriétés des composants : Définissez les propriétés et configurations des composants.
  • Frontmatter : Modifiez les métadonnées de la page en haut du fichier.
Consultez Mettre en forme le texte et Mettre en forme le code pour plus d’informations sur la syntaxe MDX.

​
Configurer les pages

Configurez les paramètres des pages pour contrôler la façon dont elles apparaissent dans la navigation, les résultats de recherche et la mise en page de votre site.
  1. Effectuez un clic droit sur un fichier.
  2. Cliquez sur Configure.

​
Personnaliser l’apparence de la navigation

Contrôlez l’apparence de la page dans la barre latérale de navigation de votre site.
  • Titre : Définissez le titre principal. Apparaît dans la navigation, les onglets du navigateur et les résultats de recherche.
  • Titre de la barre latérale : Affichez un texte plus court dans la navigation lorsque le titre complet est trop long pour la barre latérale.
  • Icône : Ajoutez un repère visuel à côté de la page pour aider les utilisateurs à l’identifier rapidement.
  • URL externe : Créez un lien vers un site externe au lieu d’une page. Utilisez cette option pour ajouter des ressources externes à votre navigation.

​
Optimiser pour la recherche et le partage

Aidez les utilisateurs à trouver votre page et améliorez son apparence lorsqu’elle est partagée.
  • Description: Rédigez un court résumé. Apparaît dans les résultats de recherche et les balises méta SEO.
  • Keywords: Ajoutez des termes de recherche pertinents pour aider les utilisateurs à découvrir cette page.
  • OG Image URL: Définissez une image d’aperçu personnalisée pour les partages sur les réseaux sociaux et les aperçus de liens.

​
Contrôler la mise en page

Choisissez comment la page s’affiche en fonction de vos besoins de contenu.
  • Mise en page standard (default) : Page par défaut avec barre latérale de navigation et table des matières.
  • Mise en page pleine largeur (wide) : Masque la table des matières pour permettre des mises en page plus larges pour les tableaux, diagrammes ou d’autres contenus.
  • Mise en page centrée (center) : Masque la barre latérale et la table des matières pour une meilleure lisibilité des pages très textuelles, comme les journaux des modifications.
  • Largeur personnalisée (custom) : Mise en page minimaliste avec uniquement la barre de navigation supérieure pour les pages de destination ou d’autres mises en page spécifiques.

​
Gérer les pages

​
Déplacer des pages

Faites glisser-déposer des pages pour les réorganiser dans votre navigation ou déplacer des fichiers entre dossiers dans l’arborescence des fichiers.

​
Dupliquer des pages

Cliquez avec le bouton droit sur une page, puis choisissez Duplicate.

​
Supprimer des pages

Cliquez avec le bouton droit sur une page et sélectionnez Delete. La suppression d’une page la retire automatiquement de la navigation.

​
Masquer des pages

Pour retirer une page de la navigation sans supprimer le fichier, cliquez avec le bouton droit sur la page et cliquez sur Hide Page. Le fichier reste dans votre référentiel et vous pouvez réafficher la page en l’ajoutant à la navigation de votre docs.json.