mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
7bcad6da0b
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
168 lines
6.8 KiB
Plaintext
168 lines
6.8 KiB
Plaintext
---
|
||
title: "配置"
|
||
description: "使用 Mintlify 网页编辑器侧边栏中的可视化配置表单编辑页面元数据、导航元素和媒体设置。"
|
||
keywords: ["editor", "configurations", "settings"]
|
||
boost: 3
|
||
---
|
||
|
||
在 Web 编辑器的 **Configurations** 面板中配置文档站点的品牌、外观和功能。
|
||
|
||
<Frame>
|
||
<img src="/images/editor/configurations-light.png" alt="浅色模式侧边栏中的 Configurations 设置。" className="block dark:hidden" />
|
||
|
||
<img src="/images/editor/configurations-dark.png" alt="深色模式侧边栏中的 Configurations 设置。" className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
<div id="brand-your-site">
|
||
## 设置站点品牌
|
||
</div>
|
||
|
||
设定站点的标识，以及它在访问者眼中的呈现方式。
|
||
|
||
* **文档标题 (Docs title) **：你的文档名称。会显示在浏览器标签页和搜索结果中。
|
||
* **摘要 (Description) **：对文档的简要概述。用于 SEO (搜索引擎优化) 和站点 metadata。
|
||
* **Favicon**：显示在浏览器标签页中的小图标。可上传 ICO、PNG、GIF 或 JPG 文件。
|
||
* **Theme**：为文档的整体外观选择一个[主题](/zh/customize/themes)。
|
||
|
||
<div id="customize-colors-and-appearance">
|
||
## 自定义颜色和外观
|
||
</div>
|
||
|
||
控制你站点的视觉标识和配色方案。
|
||
|
||
* **主色**：站点中用于链接、按钮和高亮的主要强调色。
|
||
* **浅色模式颜色**：浅色模式下的强调色变体。具体应用方式因主题而异。
|
||
* **深色模式颜色**：深色模式下的强调色变体。具体应用方式因主题而异。
|
||
* **Logo**：你的品牌 Logo。上传 PNG 或 JPG 文件。你可以为浅色和深色模式分别设置不同的 Logo。如需使用 SVG Logo，请通过 Git 将文件添加到你的仓库，并在 docs.json 配置中引用其路径。
|
||
* **Logo 链接**：用户点击 Logo 时跳转到的位置。通常是你的首页或营销站点。
|
||
* **背景颜色**：分别为浅色和深色模式设置自定义背景色。
|
||
* **背景图片**：为站点添加背景图片。上传 PNG、GIF 或 JPG 文件。
|
||
* **背景装饰**：为背景图片应用视觉效果。
|
||
* **主题切换**：控制是否向用户显示浅色/深色模式切换开关。
|
||
* **默认主题**：设置站点默认以浅色或深色模式加载。
|
||
|
||
<div id="set-custom-fonts">
|
||
## 设置自定义字体
|
||
</div>
|
||
|
||
将默认字体替换为你的品牌字体体系。
|
||
|
||
* **默认字体**：用于所有文本的基础字体系列和字重。提供一个来源 URL 和格式 (WOFF 或 WOFF2) 。
|
||
* **标题字体**：专门用于标题 (h1、h2 等) 的字体系列和字重。与正文文本分开设置。
|
||
* **正文字体**：用于正文文本和段落的字体系列和字重。
|
||
|
||
对于每种字体，指定字体系列名称、字重、来源 URL (例如 Google Fonts) ，以及格式。
|
||
|
||
<div id="configure-header">
|
||
## 配置页眉
|
||
</div>
|
||
|
||
在站点顶部添加导航元素。
|
||
|
||
* **导航栏按钮**：在页眉中添加一个主要的行动号召按钮。设置按钮类型、标签和目标 URL。
|
||
* **导航栏链接**：在页眉中添加额外的导航链接。每个链接都包含文本和一个 URL。
|
||
|
||
<div id="configure-footer">
|
||
## 配置页脚
|
||
</div>
|
||
|
||
在站点页脚中添加链接和社交媒体账号。
|
||
|
||
* **社交链接**：添加你在 GitHub、X (Twitter) 、LinkedIn、Discord、YouTube、Slack 等平台上的个人或组织主页。
|
||
* **页脚列**：通过自定义标题和链接分组，将页脚链接组织成多列。
|
||
|
||
<div id="enhance-content">
|
||
## 增强内容
|
||
</div>
|
||
|
||
自定义你的网站上内容的呈现方式。
|
||
|
||
* **缩略图背景**：为页面缩略图和社交分享预览设置自定义背景图片。
|
||
* **缩略图外观**：控制缩略图的展示方式。
|
||
* **缩略图字体**：为缩略图中的文本设置自定义字体。
|
||
* **页面眉标题**：在页面标题上方添加小标签。
|
||
* **代码块主题**：为代码块选择语法高亮主题。
|
||
* **LaTeX 支持**：启用使用 LaTeX 渲染数学公式。
|
||
|
||
<div id="set-up-ai-chat-and-search">
|
||
## 设置 AI 聊天和搜索
|
||
</div>
|
||
|
||
自定义搜索体验。
|
||
|
||
* **搜索占位文本**：在用户输入之前显示在搜索框中的文本。默认值为“Search or ask...”。
|
||
|
||
<div id="connect-integrations">
|
||
## 连接集成
|
||
</div>
|
||
|
||
连接第三方工具以实现分析、支持和合规等功能。
|
||
|
||
<div id="configure-api-specifications">
|
||
## 配置 API 规范
|
||
</div>
|
||
|
||
添加 [OpenAPI](/zh/api-playground/openapi-setup) 或 [AsyncAPI](/zh/api-playground/asyncapi-setup) 规范文件来为 API 端点编写文档。
|
||
|
||
* **OpenAPI 规范**：上传 OpenAPI 规范文件，或输入指向外部 OpenAPI 文件的 URL。
|
||
* **AsyncAPI 规范**：上传 AsyncAPI 规范文件，或输入指向外部 AsyncAPI 文件的 URL。
|
||
* **操作台显示**：选择显示交互式 API 操作台、简易 API 操作台，或不显示 API 操作台。
|
||
* **代理服务器**：为 API 请求启用或禁用代理服务器。
|
||
|
||
<div id="manage-redirects">
|
||
## 管理重定向
|
||
</div>
|
||
|
||
使用 **Redirects** 部分可以添加、编辑、搜索和删除重定向，无需手动修改 `docs.json` 文件。重定向会将用户从旧 URL 导向新 URL，在你重命名页面或重构文档结构时非常有用。有关重定向行为的更多信息，请参阅 [重定向](/zh/create/redirects)。
|
||
|
||
每条重定向包含以下字段：
|
||
|
||
- **Source**: 要从其重定向的路径，例如 `/old-path`。支持通配符。
|
||
- **Destination**: 要重定向到的路径，例如 `/new-path`。
|
||
- **Status**: 重定向的 HTTP 状态码。
|
||
- `308`: 永久重定向。用于已永久迁移的内容。这是默认状态。
|
||
- `307`: 临时重定向。当迁移是临时的时使用。
|
||
|
||
<Frame>
|
||
<img
|
||
src="/images/editor/redirects-light.png"
|
||
alt="编辑器中的重定向菜单。"
|
||
className="block dark:hidden"
|
||
/>
|
||
<img
|
||
src="/images/editor/redirects-dark.png"
|
||
alt="编辑器中的重定向菜单。"
|
||
className="hidden dark:block"
|
||
/>
|
||
</Frame>
|
||
|
||
添加重定向：
|
||
1. 点击 **Add redirect**。
|
||
2. 输入源路径和目标路径。
|
||
3. 点击 **Save**。
|
||
|
||
编辑或删除现有重定向：
|
||
1. 将光标悬停在重定向上。
|
||
2. 点击铅笔图标进行编辑，或点击垃圾桶图标进行删除。
|
||
|
||
<div id="add-analytics-and-integrations">
|
||
## 添加分析和集成
|
||
</div>
|
||
|
||
将分析和第三方工具连接到你的文档站点。
|
||
|
||
通过以下方式追踪访客行为：
|
||
|
||
* **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 键值对 |