Utilisez l’explorateur de fichiers de 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 Create a new file dans la barre latérale de l’explorateur de fichiers.Menu Fichiers dans l’Éditeur web
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’ouvrira automatiquement dans l’éditeur, prêt à accueillir du contenu.

Organiser votre navigation

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

Ouvrir docs.json

Recherchez et ouvrez le fichier docs.json dans votre répertoire racine à l’aide de l’explorateur de fichiers.
2

Repérer la section de navigation

Repérez l’emplacement 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 « themes »

Ajouter une page « themes » au groupe Profile
{
    "navigation": {
        "groups": [
            {
                "group": "Getting started",
                "pages": [
                    "index",
                    "quickstart", 
                    "installation"
                ]
            },
            {
                "group": "Profile",
                "pages": [
                    "settings",
                    "account-types", 
                    "dashboard",
                    "themes"
                ]
            }
        ]
    }
}

Modification du contenu

Modifiez vos pages en mode visuel ou en 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.
Le menu des composants déployé, mis en évidence dans l’Éditeur web Mintlify
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-coller du contenu MDX depuis d’autres sources