Gestion du contenu

Créez, modifiez et organisez vos pages de documentation

​

Navigation dans vos fichiers

Utilisez l’explorateur de fichiers dans la barre latérale pour parcourir vos fichiers de documentation. Cliquez sur un fichier pour l’ouvrir dans l’éditeur.

Appuyez sur Command + P (Ctrl + P sous Windows) pour rechercher des fichiers par nom.

​

Créer de nouvelles pages

1. Créer un nouveau fichier

   Sélectionnez l’icône Créer un nouveau fichier dans la barre latérale de l’explorateur de fichiers.

   
2. Saisir un nom de fichier

   Les noms de fichiers doivent se terminer par .mdx. Par exemple : api-reference.mdx ou getting-started.mdx.

3. Créer et ouvrir

   Appuyez sur Entrée pour créer le fichier. Il s’ouvre automatiquement dans l’éditeur, prêt à recevoir du contenu.

​

Organiser votre navigation

Ajoutez de nouvelles pages à la navigation de votre site en modifiant le fichier docs.json.

1. Ouvrir docs.json

   Recherchez et ouvrez le fichier docs.json à la racine de votre projet via l’explorateur de fichiers.

2. Repérer la section navigation

   Repérez l’endroit dans le fichier docs.json où vous souhaitez ajouter votre nouvelle page.

3. Ajouter votre page

   Insérez le nom de fichier de votre page (sans l’extension .mdx) dans le tableau pages du groupe approprié.

​

Exemple : ajouter une page de thèmes

Adding a themes page to the Profile group

{
    "navigation": {
        "groups": [
            {
                "group": "Prise en main",
                "pages": [
                    "index",
                    "quickstart", 
                    "installation"
                ]
            },
            {
                "group": "Profil",
                "pages": [
                    "settings",
                    "account-types", 
                    "dashboard",
                    "themes"
                ]
            }
        ]
    }
}

​

Modification du contenu

Apportez des modifications à vos pages en utilisant le mode visuel ou le Mode Markdown dans l’éditeur.

En mode visuel, appuyez sur / pour ouvrir le menu des composants. Ajoutez des blocs de contenu, des encadrés, des blocs de code et d’autres composants pour personnaliser votre documentation.

En Mode Markdown, vous pouvez modifier directement le MDX de vos pages. Cela peut être utile lorsque vous devez :

• Définir des propriétés spécifiques de composants
• Travailler avec des composants imbriqués complexes
• Copier et coller du contenu MDX depuis d’autres sources