导航菜单是站点中的链接列表。
通常每次添加新页面时,你都需要更新 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 文件。
不能在顶层直接使用 api 作为文件夹名称(除非将其嵌套在其它文件夹中)。Mintlify 基于 Next.js,顶层的 api 目录被保留用于内部服务调用。诸如 api-reference 的文件夹名是可行的。
"navigation": {
"tabs": [
{
"tab": "Docs",
"groups": [
{
"group": "Group Name",
"pages": ["your-folder/your-page"]
}
]
}
]
}
隐藏页面
未在 docs.json 中包含的 MDX 页面不会显示在侧边栏,但仍可通过搜索或直接链接访问。