导航菜单是每个网站上的链接列表。

每次添加新页面时,您都可能需要更新 docs.json。页面不会自动显示。

导航语法

我们的导航语法是递归的,这意味着您可以创建嵌套的导航组。在页面名称中不需要包含 .mdx

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

文件夹

只需将您的 MDX 文件放在文件夹中,并在 docs.json 中更新路径即可。

例如,要在 https://yoursite.com/your-folder/your-page 创建一个页面,您需要创建一个名为 your-folder 的文件夹,其中包含一个名为 your-page.mdx 的 MDX 文件。

除非将其嵌套在另一个文件夹中,否则不能使用 api 作为文件夹名称。Mintlify 使用 Next.js,它保留顶级 api 文件夹用于内部服务器调用。像 api-reference 这样的文件夹名称是可以接受的。

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

隐藏页面

未包含在 docs.json 中的 MDX 文件不会显示在侧边栏中,但可以通过搜索栏和直接链接访问。