Skip to main content
请将本术语表作为 Mintlify 及本文档中所用术语的快速参考。若需了解各部分如何组合,请参阅 概念

Admin MCP server

一种经过身份验证的 Model Context Protocol 服务器,允许授权的 AI 工具跨组织内的一个或多个部署读取和更新内容与设置。更改在分支上进行,需通过拉取请求才能合并。参阅 Admin MCP server

Agent(代理)

一种面向文档维护者的 AI 工具,可研究、撰写、验证并发布建议的更改。根据配置,代理可以打开拉取请求或将更改提交到部署分支。参阅 Agent

Anchor(锚点)

一种指向内部或外部目标的持久顶级导航链接。锚点是 docs.json 中可用的主要导航模式之一。参阅 Anchors

Assistant(助手)

一种面向文档读者的 AI 界面,可根据你的内容回答问题。它会引用相关页面,并可将用户直接导航至相关内容。助手不会编辑你的文档。参阅 Assistant

Automation(自动化)

一种已配置的代理任务,可按计划运行、在仓库更新后运行,或响应来自已连接集成的事件。参阅 Automations

Branch(分支)

Git 仓库中的独立工作线。使用分支可以在不影响线上站点的情况下进行更改和评审。参阅 Git 概念

Build(构建)

验证项目文件并将其转换为可部署文档站点的过程。构建可产生线上站点或预览部署。

Commit(提交)

Git 仓库中已保存的更改快照。通过网页编辑器发布会创建一次提交。参阅 Git 概念

Component(组件)

一种可复用的 MDX 元素,用于呈现结构化或交互式内容,例如卡片、标注、折叠面板、选项卡或代码组。参阅 Components

Content directory(内容目录)

仓库中包含 docs.json 和 Mintlify 部署所需文件的目录。它可以是仓库根目录,或已配置的子目录,例如 monorepo 中的 docs/。参阅 Monorepo 设置

Context repository(上下文仓库)

代理在执行任务时可读取以获取背景信息的附加仓库。上下文仓库不会成为文档站点的一部分。

Credits(积分)

用于衡量 Mintlify AI 功能使用量的单位。积分在整个组织内共享,由其部署和成员共同使用。参阅 Credits

Custom domain(自定义域名)

你连接到 Mintlify 站点的域名、子域名或子路径,用以替代默认的 .mintlify.site 地址。参阅 Custom domain

Dashboard(仪表盘)

经过身份验证的 Mintlify 应用,你的团队可在其中编辑内容、监控部署、管理成员,以及配置项目和组织设置。

Deployment(部署)

Mintlify 组织内的一个文档项目。部署将源内容和部署分支连接到线上站点。该术语也可指正在发布的特定构建。

Deployment branch(部署分支)

用于构建线上站点的 Git 分支,通常是 main。推送到或合并到此分支的更改会触发生产部署。参阅 Deployment branch

docs.json

Mintlify 站点必需的配置文件。它控制导航、外观、集成、API 设置、重定向以及其他全局行为。参阅 docs.json 一种顶级导航结构,通过菜单将相关小节分组。参阅 Dropdowns

Editor(编辑器)

Mintlify 仪表盘中基于浏览器的编辑器。它提供协作编辑、自动保存、实时预览、Git 同步和发布工作流。参阅 Editor overview

Feature branch(功能分支)

用于准备更改的任何非部署分支。功能分支可将未完成的工作与线上站点分离。

Frontmatter

MDX 页面开头由 --- 行包围的 YAML 元数据。Frontmatter 控制页面属性,例如标题、描述、图标和布局。参阅 Pages

Group(分组)

侧边栏中带标签的页面集合或嵌套分组。分组用于在导航小节内组织相关内容。参阅 Groups

Index(索引)

一种面向编码代理的搜索服务,通过 MCP 服务器或 REST API 从发布方维护的文档和网络中检索最新的技术上下文。参阅 Index

Integration(集成)

Mintlify 与其他服务之间的连接。集成可提供分析、聊天、隐私控制、SDK 示例、自动化上下文或自动化触发器。

Language(语言)

在导航中配置的、特定语言/区域版本的文档。语言会创建基于语言区域的路由和语言切换器。参阅 Languages

Live preview(实时预览)

在网页编辑器中对你未发布的编辑进行的持续更新渲染。实时预览不会公开部署。参阅 Live preview

Live site(线上站点)

由部署分支构建、可通过 Mintlify 域名或自定义域名向读者提供的生产文档站点。

llms.txt

一个自动生成的文本文件,帮助 AI 工具发现文档站点中最有价值的页面。llms-full.txt 将所有页面的内容合并到一个文件中。参阅 llms.txt

Markdown

一种用于格式化内容的纯文本语法,包含标题、列表、链接和代码块等元素。已发布的 Mintlify 页面也可通过在 URL 后附加 .md 以 Markdown 形式获取。

MDX

扩展了 JSX 的 Markdown。Mintlify 使用 .mdx 页面文件,因此你可以将标准 Markdown 与组件和自定义 React 元素结合使用。

Merge(合并)

将一个分支的更改合并到另一个分支的 Git 操作。将功能分支合并到部署分支会通过新的构建发布其更改。

Model Context Protocol (MCP)

一种开放协议,允许 AI 应用连接到工具和数据源。Mintlify 为每个已发布的站点提供一个只读的公共 MCP 服务器,并为管理部署提供一个经过身份验证的 admin MCP 服务器。 读者用来在文档站点中浏览的层级结构。在你的 docs.json 文件中通过页面、分组、选项卡、下拉菜单、产品、版本、语言和锚点来配置导航。参阅 Navigation

OpenAPI

一种描述 HTTP API 的标准格式。Mintlify 可以从 OpenAPI 文档生成端点页面、请求示例和交互式 API 试验台。参阅 OpenAPI 设置

Organization(组织)

Mintlify 工作区,包含团队成员、组织级设置、共享积分以及一个或多个部署。

Page(页面)

在你的文档站点上渲染为一个路由的 .mdx 文件。页面由 frontmatter、Markdown 内容和可选组件组成。参阅 Pages

Preview deployment(预览部署)

从拉取请求或指定分支构建的临时、可共享的站点版本。它让评审者可以在更改进入线上站点之前进行检查。参阅 Preview deployments

Product(产品)

一种顶级导航结构,用于在单个部署中为多个不同产品发布文档。每个产品都有自己的导航。参阅 Products

Project(项目)

一个通用术语,指 Mintlify 部署及其关联的仓库、配置和站点。在仪表盘设置和 API 中,通常使用更具体的术语 deployment

Publish(发布)

将文档更改写入 Git,使其可以推进到线上站点。根据分支和评审设置,发布可能直接部署、将提交保存到分支或创建拉取请求。

Pull request(拉取请求)

将一个 Git 分支的更改合并到另一个分支的提议。拉取请求支持在更改到达部署分支之前进行评审、讨论、自动化检查和预览部署。GitLab 将其称为 merge request(合并请求)。

Redirect(重定向)

将访问者从旧的或备用 URL 发送到新目标的规则。重定向可在内容迁移时保持链接可用。参阅 Redirects

Repository(仓库)

文件及其 Git 历史的集合。文档仓库是 Mintlify 站点的唯一可信来源,包含其页面、配置和资源。

Reusable snippet(可复用片段)

存储在单独文件中并可导入到一个或多个 MDX 页面的内容。更新源片段会更新所有使用它的页面。参阅 Reusable snippets

skill.md

一个自动生成的文件,向 AI 代理描述产品的能力和文档。用户可将其安装为代理技能,以在使用该产品时获得更好的结果。参阅 skill.md

Source repository(源仓库)

包含由文档描述的产品代码、API 定义或其他材料的仓库。代理可以将已连接的源仓库用作上下文,而不会将其文件发布到文档站点上。

Tab(选项卡)

一种顶级导航小节,用于面向同一受众的并行文档领域,例如指南与 API 参考。参阅 Tabs

Theme(主题)

文档站点的基础布局和视觉体系。主题控制整体呈现,而颜色、字体、徽标和其他设置对其进行定制。参阅 Themes

Version(版本)

一种导航结构,用于并行发布同一份文档的多个版本,例如 v1v2。参阅 Versions