组织、部署和站点
.mintlify.site 的 URL。你可以为你的站点连接一个自定义域名。站点包含你的内容、导航、搜索，以及你启用的任何功能，例如 AI 助手或 API playground。
本文档有时会用 project 作为一个部署及其关联的存储库、配置和站点的通用名称。
存储库是权威信息源
- 页面 (pages) 是
.mdx文件。每个页面都包含内容和 frontmatter 元数据。 docs.json是必需的配置文件。它控制导航、外观、集成、API 设置以及其他站点级的行为。- 资源 (assets) 包括页面中引用的图片、视频、字体和可下载文件。
- API 规范 (API specifications) 可以基于 OpenAPI、AsyncAPI 或 GraphQL schema 生成 API 参考页面和交互式 playground。
- 可复用文件 (reusable files) 包括 snippets 和自定义 React 组件，页面可以导入使用。
docs.json 的导航中引用某个页面时，该页面才会出现在站点导航中，否则会被隐藏。隐藏页面 只能通过直接链接访问。
页面 (page) 提供某个 URL 上的内容。其 frontmatter 控制页面级的元数据和行为，包括标题、描述、图标和布局。
导航 (navigation) 决定读者如何在页面之间浏览。你可以在 docs.json 文件中使用分组、标签、下拉菜单、产品、版本和语言等元素来配置导航。文件路径决定了页面是哪个，而它在 docs.json 中的位置决定了它在导航中的位置。
这种分离让你无需移动文件就能重新组织读者的浏览体验。它还允许你将某些工具类页面从导航中排除，同时保留通过 URL 访问的能力。
编辑和发布是不同的阶段
在编辑器中，更改会自动保存，但不会立即更新你的存储库或在线站点。当你发布时，编辑器会将更改写入 Git。之后发生的事情取决于你当前所在的分支和分支保护设置。
- 在部署分支上，发布可以直接触发在线站点的构建。
- 在功能分支上，发布可以将更改保存到该分支，或创建一个拉取请求以供审核。
- 预览部署会将拉取请求渲染到一个临时 URL，以便审核者在合并前检查结果。
- 将拉取请求合并到部署分支会触发一次生产部署。
构建会将源文件转换为读者体验
- 文档站点会为桌面和移动端用户渲染页面。
- 搜索会为站点建立索引，让读者能够找到相关页面。
- AI 助手可以基于文档回答问题，并注明其信息来源。
- 页面的 Markdown 版本、
llms.txt和skill.md可以帮助 AI 工具理解内容。 - 一个公开的 MCP 服务器让兼容的 AI 工具能够将文档作为结构化上下文来检索。
mint validate 和 mint broken-links，可以在本地捕获常见问题。