概览

标题选项

控制您文档站点顶部导航栏中显示的内容。

设置#

设置 作用
显示头部 显示或隐藏整个顶部导航栏
头部链接 头部导航中的自定义文本链接
社交链接 GitHub、Twitter、Discord 的图标链接
头部主题切换 在头部显示浅色/深色切换器
头部语言选择器 在头部显示语言切换器
头部搜索按钮 在头部显示搜索图标/按钮

如何配置#

  1. 打开您的文档站点。
  2. 浮动小部件 → 设计页眉 选项卡。
  3. 填写字段并切换选项。
  4. 保存。

添加自定义导航链接,这些链接会出现在顶部栏——对于链接到您的产品、博客、更新日志或支持非常有用。

格式:每个链接都有一个标签和一个URL

示例:

Label URL
Product https://yourapp.com
Changelog https://yourapp.com/changelog
Support https://yourapp.com/support

添加图标链接以展示您的社区和社交媒体存在。

支持的平台:

  • GitHub — 链接到您的仓库或组织
  • Twitter / X — 链接到您的 Twitter 个人资料
  • Discord — 链接到您的社区服务器

社交链接以小图标的形式出现在页眉中。 它们可以帮助读者找到您的社区,而不会通过文本链接使导航栏显得杂乱。


主题和语言在页眉中#

您可以将主题切换器和语言切换器放置在页眉中,而不是(或除了)侧边栏。

建议: 为每个控件选择一个位置,以避免重复。

  • 页眉放置:更显眼,新访客的点击深度更浅。
  • 侧边栏放置:节省页眉空间,更适合密集页眉。

侧边栏选项 → 主题选项 →


隐藏头部#

显示头部设置为关闭会移除整个顶部的导航栏。

仅在嵌入或自助服务用例中执行此操作,其中您的文档被另一个产品框起来。对于独立的文档站点,始终保持头部可见。


设计引导读者的导航。 连接您的 GitHub 仓库 →