跳转到主要内容在 Web 编辑器的 Configurations 面板中配置文档站点的品牌、外观和功能。
设定站点的标识,以及它在访问者眼中的呈现方式。
- 文档标题(Docs title):你的文档名称。会显示在浏览器标签页和搜索结果中。
- 摘要(Description):对文档的简要概述。用于 SEO(搜索引擎优化)和站点 metadata。
- Favicon:显示在浏览器标签页中的小图标。可上传 ICO、PNG、GIF 或 JPG 文件。
- Theme:为文档的整体外观选择一个主题。
控制你站点的视觉标识和配色方案。
- 主色:站点中用于链接、按钮和高亮的主要强调色。
- 浅色模式颜色:浅色模式下的强调色变体。具体应用方式因主题而异。
- 深色模式颜色:深色模式下的强调色变体。具体应用方式因主题而异。
- Logo:你的品牌 Logo。上传 SVG、PNG 或 JPG 文件。你可以为浅色和深色模式分别设置不同的 Logo。
- Logo 链接:用户点击 Logo 时跳转到的位置。通常是你的首页或营销站点。
- 背景颜色:分别为浅色和深色模式设置自定义背景色。
- 背景图片:为站点添加背景图片。上传 PNG、GIF 或 JPG 文件。
- 背景装饰:为背景图片应用视觉效果。
- 主题切换:控制是否向用户显示浅色/深色模式切换开关。
- 默认主题:设置站点默认以浅色或深色模式加载。
将默认字体替换为你的品牌字体体系。
- 默认字体:用于所有文本的基础字体系列和字重。提供一个来源 URL 和格式(WOFF 或 WOFF2)。
- 标题字体:专门用于标题(h1、h2 等)的字体系列和字重。与正文文本分开设置。
- 正文字体:用于正文文本和段落的字体系列和字重。
对于每种字体,指定字体系列名称、字重、来源 URL(例如 Google Fonts),以及格式。
在站点顶部添加导航元素。
- 导航栏按钮:在页眉中添加一个主要的行动号召按钮。设置按钮类型、标签和目标 URL。
- 导航栏链接:在页眉中添加额外的导航链接。每个链接都包含文本和一个 URL。
在站点页脚中添加链接和社交媒体账号。
- 社交链接:添加你在 GitHub、X(Twitter)、LinkedIn、Discord、YouTube、Slack 等平台上的个人或组织主页。
- 页脚列:通过自定义标题和链接分组,将页脚链接组织成多列。
自定义你的网站上内容的呈现方式。
- 缩略图背景:为页面缩略图和社交分享预览设置自定义背景图片。
- 缩略图外观:控制缩略图的展示方式。
- 缩略图字体:为缩略图中的文本设置自定义字体。
- 页面眉标题:在页面标题上方添加小标签。
- 代码块主题:为代码块选择语法高亮主题。
- LaTeX 支持:启用使用 LaTeX 渲染数学公式。
自定义搜索体验。
- 搜索占位文本:在用户输入之前显示在搜索框中的文本。默认值为“Search or ask…”。
将分析和第三方工具连接到你的文档站点。
通过以下方式追踪访客行为:
- Amplitude, Mixpanel, Heap:产品分析平台
- Google Analytics, Google Tag Manager:网站分析
- PostHog, Plausible, Fathom:注重隐私的分析工具
- Segment, Hightouch:客户数据平台
- Hotjar, LogRocket:会话回放和热力图
- Microsoft Clarity:用户行为分析
- Intercom:客户沟通
- Clearbit, Koala:访客识别
其他集成:
- Telemetry:启用或禁用使用数据遥测
- Cookies:设置自定义 cookie 的 key 和 value 键值对
设置交互式 API 参考文档。
- OpenAPI 规范:链接到你的 OpenAPI/Swagger 规范文件。
- AsyncAPI 规范:链接到你的 AsyncAPI 规范文件,用于异步 API。
- 操作台显示:控制 API 操作台的展示方式。
- 代理服务器:为从操作台发起的 API 请求配置代理服务器。