Skip to main content
导航菜单是站点中展示链接列表的区域(通常是侧边栏/顶部导航)。 你每新增一个页面,通常都需要更新一次 docs.json。页面不会自动出现在导航里。

导航语法

导航语法是递归结构,因此可以配置多层嵌套的分组。页面路径不需要包含 .mdx 后缀。

文件夹(Folders)

把 MDX 文件放进文件夹里,然后在 docs.json 里更新路径即可。 例如,如果你希望页面路径为 https://yoursite.com/your-folder/your-page,你需要创建一个 your-folder 文件夹,并在其中新增 your-page.mdx 文件。
除非将其嵌套在其他文件夹下,否则不要把顶层文件夹命名为 api。Mintlify 基于 Next.js,顶层 api 文件夹会被保留用于内部 server 调用。类似 api-reference 这样的文件夹名则没有问题。
Navigation With Folder

隐藏页面

未在 docs.json 中声明的 MDX 文件不会出现在侧边栏,但仍可通过搜索栏访问,或使用直链打开。