Skip to main content
docs.json 中的 navigation 属性用于控制文档的结构与信息层级。 通过合理配置导航,你可以更好地组织内容,帮助用户迅速找到所需信息。 在导航的根级选择一种主要的组织方式。确定主要方式后,你可以在其内部嵌套其他导航元素。

页面

页面是最基本的导航组件。每个页面都是文档存储库中的一个 MDX 文件。 页面的装饰性图形。 navigation 对象中,pages 是一个数组,其中每个条目都必须指向一个页面文件的路径。

分组

使用分组将侧边栏导航组织成不同的部分。分组可以相互嵌套、使用标签进行标注,并配合 icon 展示样式。 关于分组的装饰性图像。 navigation 对象中,groups 是一个数组,其中每一项都是一个对象,每个对象都必须包含 group 字段和 pages 字段。icontagexpanded 字段是可选的。

默认展开状态

使用 expanded 属性来控制导航侧边栏中嵌套分组的默认状态。
  • expanded: true:分组默认处于展开状态。
  • expanded: false 或省略:分组默认处于折叠状态。
expanded 属性只会影响嵌套分组——也就是分组中的分组。顶级分组始终是展开的,且无法折叠。

选项卡

选项卡可为你的文档创建彼此独立的 URL 路径分区。它们会在文档顶部生成一条水平导航栏,方便用户在各个部分之间切换。 选项卡导航的装饰性图形。 navigation 对象中,tabs 是一个数组,其中每个项都是一个对象,必须包含 tab 字段,并且还可以包含其他导航字段,例如 groups、pages、icon,或指向外部页面的链接。
菜单会为某个标签页添加下拉式导航项。使用菜单可帮助用户直接进入该标签页内的特定页面。 navigation 对象中,menu 是一个数组,其中每个条目都是一个对象,必须包含 item 字段,并且可以包含其他导航字段,例如 groups、pages、icons,或指向外部页面的链接。 菜单项只能包含 groups、pages 和外部链接。

锚点

锚点会在侧边栏顶部添加常驻的导航项。你可以用它们对内容进行分区、快速访问外部资源,或创建醒目的行动号召。 锚点导航的装饰性图形。 navigation 对象中,anchors 是一个数组,其中每个条目都是一个对象,必须包含 anchor 字段,并且可以包含其他导航字段,例如 groups、页面、icon,或指向外部页面的链接。

全局锚点

使用全局锚点为需要在所有页面中显示的外部链接提供入口,而不受用户当前查看的导航部分影响。全局锚点特别适合用于链接到文档之外的资源,例如博客、社区论坛或支持门户。
全局锚点必须包含指向外部 URL 的 href 字段,且不能包含相对路径。
下拉菜单位于侧边栏导航顶部的可展开菜单中。下拉菜单中的每个项都会跳转到文档的某个部分。 下拉导航的装饰性图形。 navigation 对象中,dropdowns 是一个数组,其中每个条目都是一个对象,必须包含 dropdown 字段,并且可以包含其他导航字段,例如 groups、pages、icons,或指向外部页面的链接。

产品

产品切换器的装饰性图形。 “产品”用于在导航中创建专门的分区,以组织针对特定产品的文档。使用“产品”将文档中的不同产品、服务或重要功能集彼此区分开。 navigation 对象中,products 是一个数组,其中每个条目都是一个对象,必须包含 product 字段,并且可以包含其他导航字段,例如 groups、pages、icons,或指向外部页面的链接。

OpenAPI

将 OpenAPI 规范直接集成到导航结构中,以自动生成 API 文档。你可以创建专门的 API 部分,或将端点(endpoint)页面放入其他导航组件中。 可以在导航层级的任意级别设置一个默认的 OpenAPI 规范。子元素将继承该规范,除非它们定义了自己的规范。
当你在某个导航元素(例如 anchor、tab 或 group)上添加 openapi 属性且未指定任何页面时,Mintlify 会自动为 OpenAPI 规范中定义的 所有端点 生成页面。若要控制显示哪些端点,请在 pages 数组中显式列出所需的端点。
有关在文档中引用 OpenAPI 端点的更多信息,请参阅 OpenAPI 设置

版本

将导航划分为不同版本。可通过下拉菜单选择版本。 版本切换器的装饰性图形 navigation 对象中,versions 是一个数组,每个项都是一个对象,必须包含 version 字段,并且可包含任何其他导航相关字段。

语言

将导航按语言进行划分。用户可以从下拉菜单中选择语言。 语言切换器的装饰性图形。 navigation 对象中,languages 是一个数组,其中每一项都是一个对象,必须包含 language 字段,并且可以包含任意其他导航字段,包括特定语言的横幅配置。 我们目前支持以下语言的本地化:

阿拉伯语(ar)

捷克语(cs)

中文(cn)

中文(zh-Hant)

荷兰语(nl)

英语(en)

法语(fr)

德语(de)

希伯来语(he)

印地语(hi)

印尼语(id)

意大利语(it)

日语(jp)

韩语(ko)

拉脱维亚语(lv)

挪威语(no)

波兰语(pl)

葡萄牙语(pt-BR)

罗马尼亚语(ro)

俄语(ru)

西班牙语(es)

瑞典语(sv)

土耳其语(tr)

乌克兰语(ua)

乌兹别克语(uz)

越南语(vi)

如需自动翻译支持,请联系销售团队以商讨解决方案。

嵌套

导航元素可以相互嵌套,以创建复杂的层级结构。你必须有一个根级父导航元素,例如 tabs、groups 或下拉菜单。你可以在主要导航结构中嵌套其他类型的导航元素。 在导航层级结构的每一层中,每个导航元素只能包含一种类型的子元素。比如,一个 tab 可以包含锚点,锚点下面可以包含 groups,但一个 tab 不能在同一级同时包含锚点和 groups。
面包屑导航会在页面顶部显示完整的导航路径。某些主题默认启用面包屑导航,另一些则未启用。你可以在 docs.json 中通过 styling 属性控制站点是否启用面包屑导航。

交互配置

docs.json 中使用 interaction 属性来控制用户与导航元素的交互方式。

为 groups 启用自动导航

当用户展开一个导航分组时,某些主题会自动跳转到该分组中的第一页。你可以使用 drilldown 选项覆盖主题的默认行为。
  • 设为 true:在选择导航分组时强制自动跳转到第一页。
  • 设为 false:不进行跳转,选择时仅展开或折叠分组。
  • 留空不设置:使用主题的默认行为。