Navigation

Le menu de navigation est la liste des liens présent sur chaque site web.

Vous aurez probablement besoin de mettre à jour docs.json à chaque fois que vous ajoutez une nouvelle page. Les pages n'apparaissent pas automatiquement.

Syntaxe de navigation

Notre syntaxe de navigation est récursive, ce qui signifie que vous pouvez créer des groupes de navigation imbriqués. Vous n'avez pas besoin d'inclure .mdx dans les noms de pages.

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Pour commencer",
          "pages": ["quickstart"]
        }
      ]
    }
  ]
}

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Pour commencer",
          "pages": [
            "quickstart",
            {
              "group": "Pages de référence imbriquées",
              "pages": ["nested-reference-page"]
            }
          ]
        }
      ]
    }
  ]
}

Dossiers

Placez simplement vos fichiers MDX dans des dossiers et mettez à jour les chemins dans docs.json.

Par exemple, pour avoir une page à https://votresite.com/votre-dossier/votre-page, vous créeriez un dossier appelé votre-dossier contenant un fichier MDX appelé votre-page.mdx.

attention

Vous ne pouvez pas utiliser api pour le nom d'un dossier sauf si vous l'imbriquez dans un autre dossier. Mintlify utilise Next.js qui réserve le dossier de premier niveau api pour les appels serveur internes. Un nom de dossier comme api-reference serait accepté.

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Nom du groupe",
          "pages": ["votre-dossier/votre-page"]
        }
      ]
    }
  ]
}

Pages cachées

Les fichiers MDX non inclus dans docs.json n'apparaîtront pas dans la barre latérale mais sont accessibles via la barre de recherche et en y accédant directement via un lien.