Passer au contenu principal
La barre latérale de l’éditeur regroupe vos pages en sections.
  • Navigation : Les pages et groups présents dans la navigation de votre site, tels que définis dans docs.json.
  • Files : Tous les fichiers de votre dépôt qui ne figurent pas dans votre navigation, y compris les images, les vidéos, les spécifications OpenAPI et docs.json.
  • Recents : Les trois dernières pages privées que vous avez ouvertes.
  • Starred : Pages privées que vous avez marquées d’une étoile. Pour marquer une page d’une étoile, ouvrez son menu d’options et sélectionnez Star. Les étoiles vous sont personnelles.
  • Personal : Vos pages privées.
  • Shared with me : Pages que des collègues vous ont partagées directement.
Personal, Shared with me, Recents et Starred n’apparaissent qu’après que vous avez créé une page privée ou qu’un collègue vous en a partagé une. Recents, Starred et Shared with me restent masqués tant qu’ils sont vides.
Dans une base, la section Navigation s’appelle Teamspace et Personal apparaît toujours.
Faites glisser un en-tête de section pour réordonner les sections. Cliquez sur un en-tête de section pour la réduire ou la développer. L’éditeur enregistre vos sections réduites dans votre compte et l’ordre des sections dans votre navigateur. La barre supérieure change en fonction de la page ouverte. Sur une page du site, elle comporte le sélecteur de branch, Preview et Publish. Sur une page privée, elle comporte Share.

​
Créer une page

Pour créer une page, cliquez sur le bouton plus à l’endroit souhaité, puis sélectionnez New page.
  • En-tête de la section Navigation : Ajoute une nouvelle page en haut de votre navigation.
  • Un group ou un autre élément de navigation : Ajoute une nouvelle page à l’intérieur de cet élément.
  • En-tête de la section Files ou dossier dans Files : Crée un fichier qui n’est pas dans votre navigation.
Le bouton New page en bas de la barre latérale ajoute lui aussi une page en haut de votre navigation.
Pour ajouter à votre navigation une page qui existe déjà dans votre dépôt, cliquez sur le bouton plus et sélectionnez Add existing page.
Les mêmes menus créent des éléments de navigation comme des groups, tabs, anchors, dropdowns, versions, languages et products. Pour plus d’informations sur chaque élément, consultez Navigation.

​
Modifier les paramètres d’une page

Définissez le titre, la description et l’icône d’une page directement en haut de la page. Survolez le titre et cliquez sur Add icon pour choisir une icône ou un emoji. Lorsqu’une page avec une icône est ouverte, votre onglet de navigateur affiche cette icône. Pour les autres paramètres, ouvrez le menu d’options de la page dans la barre latérale, ou cliquez sur More options en haut à droite de la page, puis sélectionnez Page settings. Le panneau Page settings regroupe les paramètres en sections :
  • URL : Le chemin et l’URL de redirection de la page. Modifier le chemin déplace le fichier.
  • Navigation : Titre dans la barre latérale, tag, mode et si la page est masquée.
  • SEO & sharing : Image Open Graph et mots-clés.
  • Thumbnails : Remplacements de miniatures pour l’image d’aperçu social de la page. Chaque paramètre utilise la valeur héritée, sauf si vous le modifiez.
Les groups, tabs et autres éléments de navigation ont leurs propres panneaux de paramètres, comme Group settings et Tab settings. Ouvrez-les depuis le menu d’options de l’élément. Les groups, tabs, anchors, dropdowns, products, versions, languages et menu items ont aussi une section Thumbnails qui définit des remplacements de miniatures pour les pages de cette section. Consultez Pages pour plus d’informations sur les paramètres spécifiques. Dans une base, le panneau Page settings comporte aussi une section Properties, dans laquelle vous pouvez ajouter un propriétaire et des propriétés personnalisées à la page.

​
Modifier les pages de référence d’API

Les pages qui ont un champ openapi, openapi-schema ou api dans leur frontmatter affichent l’endpoint et ses champs dans l’éditeur, comme sur votre site publié. L’éditeur identifie ces sections avec le libellé Generated from OpenAPI. Vous ne pouvez pas les modifier dans l’éditeur. Pour les changer, mettez à jour votre spécification OpenAPI ou le frontmatter de la page. Consultez Configuration OpenAPI. Rédigez votre propre contenu sur la page entre l’endpoint et les champs. Si la page n’a pas de description dans son frontmatter, l’éditeur affiche la description de l’opération issue de votre spécification OpenAPI. Cliquez sur la description pour la modifier. Si vous la changez, l’éditeur enregistre votre texte comme description de la page, qui remplace la description de la spécification sur cette page.

​
Ajouter des médias

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, ou faire glisser une image ou une vidéo depuis la section Files sur la page.
  • Les fichiers téléversés sont enregistrés dans vos dossiers images/, videos/ et files/ et sont inclus dans le commit de votre prochaine publication. Avant d’insérer un fichier téléversé, vous pouvez modifier son chemin.
  • Vous pouvez téléverser des images PNG, JPG, GIF, WebP, AVIF, ICO et BMP, des vidéos MP4, WebM et MOV, ainsi que des fichiers PDF. Les fichiers SVG ne peuvent pas être téléversés dans l’éditeur.
  • Chaque fichier téléversé peut atteindre 20 Mo.
  • Cliquez sur une image pour la sélectionner. Faites glisser l’image pour la déplacer, y compris vers l’intérieur ou l’extérieur de composants comme les frames, cards, tabs et callouts. Faites glisser les poignées sur ses bords pour la redimensionner. Appuyez sur Delete ou Backspace pour la supprimer.
  • Pour afficher une image différente en mode sombre, sélectionnez l’image, cliquez sur Edit Image, puis définissez Dark mode image.
  • Saisissez /embed pour ajouter une intégration. Sur l’onglet Video link, collez une URL YouTube, Loom ou Vimeo, ou un lien direct vers un fichier vidéo. Sur l’onglet Embed code, collez un iframe ou un autre extrait d’intégration.
Pour la mise en forme des images et l’utilisation du composant Frame, consultez Images et intégrations.

​
Organiser la navigation

Faites glisser des éléments dans Navigation pour les réordonner ou les imbriquer. L’éditeur écrit vos modifications dans docs.json lorsque vous publiez.
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 sélectionner plusieurs éléments, faites Shift+clic pour sélectionner une plage, ou Cmd+clic (macOS) ou Ctrl+clic (Windows) pour ajouter ou retirer des éléments individuels. Faites glisser la sélection ou faites un clic droit dessus pour déplacer, dupliquer ou supprimer d’un seul coup tous les éléments sélectionnés. Appuyez sur Esc pour désélectionner. Pour transformer un group ou un autre élément en un type différent, ouvrez son menu d’options et sélectionnez Convert to. Les éléments de navigation globaux, comme les anchors et tabs qui apparaissent dans toutes les sections de votre site, ne figurent pas dans l’arborescence de la barre latérale. Pour les gérer, ouvrez une page du site, cliquez sur Site configuration en bas de la barre latérale, puis allez dans Navigation.

​
Ajouter et retirer des pages de votre navigation

Faites glisser une page depuis Files dans Navigation pour l’ajouter à cette position. Faites glisser un dossier pour l’ajouter comme group. Vous pouvez aussi sélectionner Move to navigation depuis le menu d’options d’un fichier. Pour retirer une page ou un group de votre navigation sans supprimer ses fichiers, faites-le glisser depuis Navigation dans Files, ou sélectionnez Move to files dans son menu d’options. Un toast d’annulation apparaît après le déplacement.

​
Files

Cliquez sur un fichier dans Files pour l’ouvrir.
  • Les images s’ouvrent dans un aperçu. Cliquez sur l’image pour zoomer.
  • Les vidéos se lisent dans l’éditeur.
  • docs.json s’ouvre en mode source.
  • Les fichiers texte et de code, comme YAML, JSON et CSS, s’ouvrent dans l’éditeur source.
  • L’éditeur ne peut pas prévisualiser les autres fichiers, comme les polices et les archives.
Pour téléverser des fichiers, faites-les glisser depuis votre ordinateur dans la section Files.

​
Déplacer une page

Pour déplacer une page, ouvrez son menu d’options et sélectionnez Move, ou appuyez sur Cmd + Shift + P (macOS) ou Ctrl + Shift + P (Windows) lorsque la page est ouverte. Vous pouvez ouvrir le menu d’options d’une page depuis :
  • More options en haut à droite d’une page ouverte.
  • Le menu à côté d’une page dans la barre latérale.
  • Un clic droit sur une page dans la barre latérale.
Dans le sélecteur, recherchez pour filtrer les destinations, développez les dossiers et les groups pour voir les destinations imbriquées et sélectionnez une destination pour déplacer la page. Ce que propose le sélecteur dépend de l’emplacement de l’élément dans la barre latérale :
  • Navigation : les pages et les groups sont déplacés vers un autre group de votre navigation. Déplacer un group déplace également ses pages.
  • Files : le fichier des pages est déplacé vers un autre dossier.
  • Personal : les pages et dossiers privés sont déplacés vers un autre dossier privé, ou dans Navigation pour les ajouter à votre site. Consultez Déplacer une page vers votre site.
Les editors et les admins peuvent déplacer les pages du site. Vous pouvez déplacer les pages et dossiers privés dans Personal, mais pas les pages dans Shared with me.

​
Copier une page vers un autre projet

Pour copier une page vers un autre projet de votre organisation, ouvrez son menu d’options et sélectionnez Copy to a project, puis choisissez le projet. Vous devez avoir le rôle editor ou admin et un accès aux deux projets.

​
Supprimer une page

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 la barre latérale. Supprimer une page du site supprime à la fois le fichier et son entrée de navigation. Un toast avec Undo apparaît après la suppression. Pour retirer une page de votre navigation sans supprimer son fichier, sélectionnez plutôt Move to files. Supprimer une page privée est définitif. Pour les pages privées, le menu More options affiche Delete page. Les editors et les admins peuvent supprimer les pages du site.

​
Historique des versions

L’historique des versions vous permet de comparer une page avec ses versions enregistrées antérieures et d’en restaurer une. Il n’est pas disponible pour docs.json. L’éditeur enregistre une nouvelle version environ 10 secondes après que vous arrêtez de modifier une page. Si vous modifiez en continu, l’éditeur enregistre une version au moins une fois par minute. Les modifications synchronisées depuis votre dépôt Git créent aussi des versions, qui affichent Git sync comme auteur. L’historique des versions est limité à la branch. Seul l’historique de la branch actuelle est disponible.
  1. Cliquez sur More options en haut à droite de la page.
  2. Cliquez sur Version history.
  3. Sélectionnez une version. L’éditeur montre en quoi la page actuelle diffère de cette version.
  4. Pour la restaurer, cliquez sur Restore this version.
Pour quitter la comparaison, cliquez sur Exit comparison. Tout le monde peut comparer les versions. Les editors et les admins peuvent restaurer les versions des pages du site. Pour les pages privées, vous avez besoin du rôle Editor ou Full Access sur la page pour restaurer une version. Restaurer une version remplace le contenu actuel de la page. Lorsque vous restaurez une page du site, 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.

​
Pages privées

Les pages privées sont des brouillons qui se trouvent dans la section Personal de la barre latérale. Elles vous sont privées et ne sont pas commitées dans votre dépôt. Elles sont enregistrées automatiquement et n’ont pas d’étape de publication. Elles n’apparaissent jamais sur votre site publié tant que vous ne les déplacez pas dans votre site. Si vous utilisez déjà des pages privées, créez une page ou un dossier en cliquant sur le bouton plus sur l’en-tête de la section Personal, puis en sélectionnant New page ou New folder. Sur les sites, Personal n’apparaît que pour les personnes qui ont des pages privées ou à qui une page privée a été partagée. Pour importer des fichiers Markdown en tant que pages privées, faites glisser des fichiers Markdown et MDX depuis votre ordinateur vers Personal ou vers un dossier privé. Pour définir une icône ou un emoji sur un dossier privé, ouvrez son menu d’options et sélectionnez Change icon. Choisissez une icône dans l’onglet Icons ou un emoji dans l’onglet Emojis, ou sélectionnez Remove pour l’effacer.

​
Partager une page privée

Pour partager une page privée, ouvrez-la et cliquez sur Share dans la barre supérieure. Pour partager un dossier, ouvrez son menu d’options dans la barre latérale et sélectionnez Share. Recherchez des collègues et attribuez un rôle à chacun :
  • Full Access : Modifier et partager. Le propriétaire de la page peut aussi la déplacer vers votre site.
  • Editor : Créer et modifier du contenu.
  • Commenter : Consulter et commenter le contenu.
  • Viewer : Consulter le contenu uniquement.
Sous l’accès général, sélectionnez Only people invited ou Everyone at votre organisation. Seules les personnes disposant de Full Access peuvent modifier qui a accès. Si vous disposez d’un accès Viewer à une page, cliquez sur View only dans la barre supérieure, puis sur Request edit access. Les personnes disposant de Full Access peuvent approuver la demande. Les pages qui vous sont partagées apparaissent dans Shared with me. Lorsqu’un collègue partage directement une page ou un dossier avec vous, l’élément apparaît également dans votre boîte de réception. Pour retirer une page de votre barre latérale, ouvrez son menu d’options et sélectionnez Leave.

​
Déplacer une page vers votre site

Pour ajouter une page privée à votre site, ouvrez son menu d’options dans la barre latérale, sélectionnez Move, puis choisissez Navigation ou un group qu’elle contient. Vous pouvez aussi faire glisser la page dans Navigation. Vous avez besoin du rôle editor ou admin. La page est déplacée dans votre navigation sur votre branch actuelle en tant que modification non publiée, et la barre latérale la met en évidence. Publiez pour la mettre en ligne. Déplacer un dossier l’ajoute à votre navigation comme un group, avec toutes ses pages et son icône. Vous pouvez déplacer jusqu’à 20 pages à la fois.
Déplacer une page vers votre site est à sens unique. La page privée est supprimée immédiatement, et annuler la modification sur votre branch ne la restaure pas. Vous ne pouvez pas redéplacer une page du site vers Personal.