L’espace de travail de l’éditeur est divisé en deux onglets : Home et Publishing.Home est votre espace de travail. Il affiche les fichiers de contenu de votre dépôt, y compris vos pages privées, qu’elles apparaissent ou non sur votre site publié.Publishing est votre site publié. Il affiche la navigation que voient vos visiteurs, ainsi que les paramètres de votre site.Home masque certains fichiers par défaut, notamment docs.json, les fichiers et dossiers dont le nom commence par un point, les fichiers sans extension, les fichiers Markdown en majuscules comme README.md, ainsi que les fichiers .css, .js, .jsx, .mjs, .cjs et .pdf. Pour afficher tous les fichiers, activez Show all files ou appuyez sur Cmd + Shift + . (macOS) ou Ctrl + Shift + . (Windows).
Pour ajouter une page à votre navigation, cliquez sur le bouton plus sur l’élément de navigation où vous la souhaitez. Saisissez un nom pour votre page. L’éditeur ajoute l’extension .mdx à votre place.
Saisissez /image ou /video pour téléverser un fichier ou en choisir un déjà présent dans votre dépôt. Vous pouvez aussi faire glisser des fichiers depuis votre ordinateur sur la page. Pour réutiliser un média, faites glisser une image ou une vidéo depuis l’arborescence de navigation sur une page.
Les fichiers téléversés sont enregistrés dans vos dossiers images/ et videos/ et sont inclus dans le commit de votre prochaine publication.
Les formats pris en charge sont PNG, JPG, JPEG, GIF, WebP, SVG, MP4 et WebM.
Pour afficher des images différentes en mode clair et en mode sombre, survolez une image insérée et utilisez Light/dark variants.
Saisissez /embed et collez une URL YouTube, Loom ou Vimeo pour générer l’iframe. Pour tout autre cas, activez Manual embed afin d’écrire du HTML personnalisé.
Pour la mise en forme des images et l’utilisation du composant Frame, consultez Images et intégrations.
Faites glisser des éléments dans la vue Navigation pour les réordonner ou les imbriquer. L’éditeur écrit vos modifications dans docs.json lorsque vous publiez. Pour connaître le rôle de chaque élément de navigation, notamment les groups, tabs, anchors, dropdowns, menus, products, versions et languages, consultez Navigation.
Certains éléments ne peuvent pas être imbriqués dans d’autres. Par exemple, les tabs ne peuvent pas être imbriqués dans des groups. L’éditeur empêche les combinaisons non valides.
Pour modifier le titre, le slug, la description ou le layout d’une page, ouvrez ses paramètres depuis l’arborescence de navigation. Consultez Pages pour plus d’informations sur chaque paramètre.
Pour supprimer une page, cliquez sur More options en haut à droite de la page, puis sur Move to trash. Vous pouvez aussi supprimer une page depuis son menu d’options dans l’arborescence de navigation.La suppression d’une page supprime à la fois le fichier et son entrée de navigation. Malgré le libellé Move to trash, il n’existe pas de vue corbeille permettant de restaurer des pages. Si vous supprimez une page par erreur, utilisez l’invite d’annulation qui apparaît après la suppression. La suppression est commitée dans votre dépôt lorsque vous publiez : après la publication, vous ne pouvez restaurer la page qu’à partir de l’historique de votre dépôt.Pour retirer une page de votre navigation publiée sans supprimer son fichier, sélectionnez Remove from publishing dans le menu d’options de la page dans l’arborescence de navigation.Les viewers ne peuvent pas supprimer de pages. Pour les pages privées, le menu affiche Delete page à la place, et la suppression est immédiate car les pages privées ne sont pas commitées dans votre dépôt.
L’historique des versions vous permet de consulter et de restaurer des versions enregistrées antérieures d’une page. Il n’est pas disponible pour docs.json.Les viewers peuvent consulter et comparer les versions enregistrées des pages privées. Les editors et les admins peuvent les restaurer.L’éditeur enregistre une nouvelle entrée dès que le contenu diffère de la dernière version enregistrée. L’historique des versions est limité à la branch. Seul l’historique de la branch actuelle est disponible.Pour consulter l’historique des versions, cliquez sur More options en haut à droite de la page, puis sur Version history.Si vous restaurez une version, cela écrase les modifications non enregistrées que vous avez faites sur la page. Lorsque vous restaurez une page publique, elle n’est restaurée que sur votre branch actuelle. Lorsque vous restaurez une page privée, elle est restaurée sur toutes les branches.
Les pages privées sont des brouillons qui se trouvent dans la section Personal de l’onglet Home. Elles vous sont privées, ne sont pas commitées dans votre dépôt et n’apparaissent jamais sur votre site publié.Pour créer une page ou un dossier privé, cliquez sur le bouton plus sur l’en-tête de la section Personal, puis sélectionnez New page ou New folder.Faire glisser une page ou un dossier privé dans votre workspace le met immédiatement à la disposition de vos collaborateurs, sans pour autant l’ajouter à la navigation de votre site.
Vous ne pouvez pas ramener du contenu du workspace vers la section Personal. Rendre publique une page privée est un changement irréversible.
