Passer au contenu principal

​
Workspace et Site

La barre latérale de l’éditeur comporte deux onglets : Workspace et Site. Workspace contient les pages qui ne font pas partie de votre dépôt Git ni de votre site publié. Les pages du workspace sont enregistrées automatiquement et n’ont pas d’étape de publication.
  • Recents : Pages du workspace que vous avez ouvertes récemment.
  • Starred : Pages du workspace 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.
  • Teamspace : Pages partagées avec toute votre organisation. Consultez Teamspace.
  • Shared with me : Pages que des collègues vous ont partagées directement.
Site contient votre dépôt et les pages que vos visiteurs voient sur votre site publié.
  • 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, starred, shared with me et teamspace n’apparaissent que lorsqu’ils contiennent quelque chose. Faites glisser un en-tête de section pour réordonner les sections d’un onglet. Cliquez sur un en-tête de section pour la réduire ou la développer. L’éditeur enregistre l’ordre des sections et leur état de réduction dans votre compte. Changer d’onglet réouvre la dernière page que vous avez consultée sur cet onglet. La barre supérieure change avec l’onglet. Share n’apparaît que sur Workspace. Le sélecteur de branch, Preview et Publish n’apparaissent que sur Site.

​
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 à la fin 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 l’onglet Site ajoute lui aussi une page à la fin 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.
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. Consultez Pages pour plus d’informations sur les paramètres spécifiques.

​
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, cliquez sur Site configuration en bas de l’onglet Site, 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 dans un autre dossier, ouvrez son menu d’options et sélectionnez Move to, 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 dossiers, développez les dossiers pour voir les destinations imbriquées et sélectionnez un dossier pour déplacer la page. Déplacer une page du site déplace son fichier dans le nouveau dossier. Les editors et les admins peuvent déplacer les pages du site. Vous pouvez déplacer les pages du workspace que vous gérez dans Personal et Teamspace, mais pas les pages dans Shared with me.

​
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 du workspace est définitif. Pour les pages du workspace, 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 du workspace, 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 du workspace, 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 l’onglet Workspace. Elles vous sont privées, ne sont pas commitées dans votre dépôt et n’apparaissent jamais sur votre site publié tant que vous ne les déplacez pas dans votre site. 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. Le bouton New page en bas de l’onglet Workspace crée lui aussi une page privée. Pour définir une icône ou un emoji sur un dossier du workspace, 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, déplacer vers votre site et partager.
  • Editor : Créer et modifier du 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. Les pages qui vous sont partagées apparaissent dans Shared with me. Pour retirer une page de votre barre latérale, ouvrez son menu d’options et sélectionnez Leave.

​
Teamspace

Les pages du teamspace sont accessibles à toute votre organisation. Comme les pages privées, elles ne sont pas commitées dans votre dépôt. L’accès dépend de votre rôle. Les editors et les admins peuvent modifier et gérer les pages du teamspace, et les viewers peuvent les lire. Comme tout le monde y a déjà accès, vous ne pouvez pas partager individuellement les pages du teamspace. La section Teamspace n’apparaît dans la barre latérale que lorsqu’elle contient des pages ou des dossiers ajoutés par un membre de votre organisation. Mintlify la masque lorsqu’elle est vide ou ne contient que le dossier et le guide de bienvenue par défaut. Pour créer une page ou un dossier du teamspace, cliquez sur le bouton plus sur l’en-tête de la section Teamspace, puis sélectionnez New page ou New folder.

​
Déplacer une page vers votre site

Pour publier une page personal ou teamspace, ouvrez son menu d’options dans la barre latérale et sélectionnez Move to site. La page est déplacée dans votre navigation, et la barre latérale bascule sur Site et la met en évidence. Déplacer un dossier l’ajoute à votre navigation comme un group, avec toutes ses pages et son icône. L’option Move to site déplace jusqu’à 20 pages à la fois.
Vous ne pouvez pas déplacer des pages entre Personal et Teamspace. Déplacer une page vers votre site est à sens unique. Vous ne pouvez pas déplacer une page depuis Site vers Workspace.

Sujets connexes

Rédiger et modifier avec l'agentCréer des mises en page personnaliséesCréer manuellement des pages d'API