配置

在 Mintlify Web 编辑器的 Configurations 面板中编辑站点品牌、外观、导航和功能设置，团队实时同步。

在 Web 编辑器的 Configurations 面板中配置文档站点的品牌、外观和功能。配置更改会与同一分支上的其他编辑器实时同步。

该面板按照与 docs.json 顶级属性对应的章节组织。使用右侧的目录在章节之间跳转。

​

General

设置站点的标识及其对访问者的展示方式。

• Name：项目名称。显示在浏览器标签页和搜索结果中。
• Description：项目简要概述。用于 SEO 和 AEO。

​

Branding

上传标识您站点的品牌资产。

• Logo：品牌 logo。上传 PNG 或 JPG 文件。可分别设置浅色和深色版本，并可选填点击跳转 URL。要使用 SVG logo，将文件添加到您的仓库，并在 docs.json 中引用其路径。
• Favicon：浏览器标签中显示的小图标。上传 ICO、PNG、GIF 或 JPG 文件。如需可分别设置浅色和深色版本。

​

Styling

控制站点的视觉风格和配色方案。

• Theme：为站点选择整体外观主题。
• Primary color：站点中链接、按钮和高亮元素使用的主强调色。
• Light color：深色模式下使用的强调色。具体应用方式因主题而异。
• Dark color：浅色模式下使用的强调色。具体应用方式因主题而异。
• Background color：为浅色和深色模式分别设置自定义背景色。
• Icon library：所有图标属性使用的图标库。默认为 fontawesome。
• Strict appearance：将站点锁定为单一外观模式，并隐藏主题切换器。
• Default appearance：站点默认以 system、light 还是 dark 模式加载。
• Background decoration：为背景应用视觉样式（gradient、grid 或 windows）。
• Background image：可选的背景图像。可设置单张图像，或为浅色和深色模式分别设置。

​

Typography

用您品牌的字体替换默认字体。

• Font family：任意 Google Fonts 家族开箱即用。要使用自托管字体，请提供源 URL 和格式（woff 或 woff2）。
• Weight：通常 400 为常规，700 为粗体。可变字体支持像 550 这样的精确字重。
• Heading font：应用于所有标题（h1–h6）的可选覆盖。
• Body font：应用于正文及页面其余部分的可选覆盖。

​

Navbar

在站点顶部添加导航元素。

• Primary button：标题栏中的主要号召性按钮。设置类型、label 和目标 URL。
• Navbar links：标题栏中的其他导航链接。每个链接包含文本和 URL。

​

Footer

为站点 footer 添加链接和社交媒体账号。

• Social links：GitHub、X、LinkedIn、Discord、YouTube、Slack 等平台的个人资料。
• Footer columns：启用最多四列带自定义标题的链接组。

​

Banner

在每个页面顶部显示公告栏。

• Content：横幅文字。支持基本 MDX 格式，如链接、加粗和斜体。不支持自定义组件。
• Dismissible：在横幅右侧显示关闭按钮。
• Type：视觉样式。info 使用主品牌色，warning 使用琥珀色背景，critical 使用红色背景。默认为 info。
• Color：使用自定义十六进制颜色覆盖横幅背景色。可分别设置浅色和深色值。

​

Thumbnail

自定义页面缩略图和社交分享预览图。

• Background：缩略图的自定义背景图。
• Appearance：以 light 或 dark 模式渲染缩略图。未设置时根据主题色自动生成。
• Font：缩略图文本使用的自定义字体。

​

Content

自定义站点中的内容显示方式。

• Code block theme：使用 system 跟随站点浅色/深色模式，使用 dark 始终使用深色主题，或选择自定义 Shiki 主题。
• Custom code languages：注册额外的语法高亮语言。
• Page eyebrow：在页面标题上方显示小标签。可选 section 或 breadcrumbs。
• Timestamps：在所有页面显示内容最后修改日期。
• LaTeX：加载 LaTeX（KaTeX）样式表以渲染数学公式。

​

Context menu

配置页面上下文菜单中的快捷操作。

• Options：多选下拉，包含 copy、view、以及在 chatgpt、claude、cursor 等 AI 助手中打开页面等操作。
• Display：选项的显示位置。header（默认）在页面顶部的上下文菜单中显示；toc 在目录侧边栏中显示。

​

Navigation

调整全站的导航行为。

• Drilldown：用户点击导航分组时，自动导航到第一个页面。

​

Search

自定义搜索体验和反馈。

• Search placeholder：用户输入前搜索框中显示的提示文本。默认为 Search or ask。
• Feedback：在每个页面显示点赞/点踩按钮或「Suggest edits」链接。

​

API reference

记录您的 API 端点。

• OpenAPI specs：添加 OpenAPI 规范文件以生成 API 参考页面。
• AsyncAPI specs：添加 AsyncAPI 规范文件以生成 API 参考页面。
• MDX server：API playground 的自定义 MDX server 端点。
• Playground display：显示交互式 API playground、简单 API playground 或不显示。
• Proxy server：启用或禁用 API 请求的代理服务器。
• mdx.schema：是否在 API 参考页面上渲染 schema 部分。

​

Redirects

使用 Redirects 部分来添加、编辑、搜索和删除重定向，无需手动编辑 docs.json。更多信息请参见重定向。

每个重定向包含以下字段：

• Source：重定向源路径，例如 /old-path。支持通配符。
• Destination：重定向目标路径，例如 /new-path。支持通配符。
• Status：HTTP 状态码。
  • 308：永久重定向。默认值。
  • 307：临时重定向。

添加重定向：

1. 单击 Add redirect。
2. 输入源和目标。
3. 单击 Save。

要编辑或删除现有重定向，将光标悬停在该行上，使用内联编辑图标或 X 删除。

​

SEO

为搜索引擎配置 metatags 和索引。

• Metatags：应用于整个站点的自定义 <meta> 标签。添加键值对，例如 og:image 或 twitter:card。
• Indexing：选择是否索引隐藏页面。

​

Analytics

接入分析平台以跟踪访客行为。支持的提供商包括 Amplitude、Mixpanel、Heap、Google Analytics、Google Tag Manager、PostHog、Plausible、Fathom、Segment、Hightouch、Hotjar、LogRocket、Microsoft Clarity、Intercom、Clearbit 等。

每个条目以内联行展示。使用 X 图标移除集成。

​

404 page

自定义用户访问到不存在页面时的体验。

• Redirect to home：开启时，缺失的页面会重定向到主页。关闭时显示 404 页面，并可自定义其标题和描述。
• Title：404 页面显示的标题。
• Description：404 页面显示的副标题。

​

Variables

定义可在内容中复用的自定义变量。每个变量是一个键值对。使用 X 图标移除变量。