ナビゲーション

ナビゲーションメニューは、すべてのウェブサイトに表示されるリンクのリストです。

新しいページを追加するたびに docs.json を更新する必要があります。ページは自動的に表示されません。

ナビゲーション構文

ナビゲーション構文は再帰的であり、ネストされたナビゲーショングループを作成できます。ページ名に .mdx を含める必要はありません。

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Getting Started",
          "pages": ["quickstart"]
        }
      ]
    }
  ]
}

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Getting Started",
          "pages": [
            "quickstart",
            {
              "group": "Nested Reference Pages",
              "pages": ["nested-reference-page"]
            }
          ]
        }
      ]
    }
  ]
}

フォルダ

MDX ファイルをフォルダに入れ、docs.json のパスを更新するだけです。

例えば、https://yoursite.com/your-folder/your-page にページを配置したい場合は、your-page.mdx という名前の MDX ファイルを含む your-folder というフォルダを作成します。

警告

フォルダ名に api を使用することはできません。別のフォルダの中にネストしない限り使用できません。Mintlify は Next.js を使用しており、トップレベルの api フォルダは内部サーバーコール用に予約されています。api-reference のようなフォルダ名は受け入れられます。

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Group Name",
          "pages": ["your-folder/your-page"]
        }
      ]
    }
  ]
}

非表示ページ

docs.json に含まれていない MDX ファイルはサイドバーに表示されませんが、検索バーまたは直接リンクを通じてアクセスできます。