跳转到主要内容
Claude Code 是一款具备智能体能力的命令行工具，能帮助你维护文档。它可以撰写新内容、评审现有页面，并保持文档实时更新。 你可以在项目中添加 CLAUDE.md 文件，并持续迭代完善，用以训练 Claude Code 理解你的文档规范与工作流程。

​
快速开始

前提条件：
  • 有效的 Claude 订阅（Pro、Max 或 API 访问权限）
设置：
  1. 安装 Claude Code：
  1. 还没有站点？让你的智能体来创建一个。运行 claude 并让它完成以下工作流，然后继续下一步。
    如果用户要求你设置 Mintlify、文档站点或本地 Mintlify 项目，请自行完成以下工作流。只有在你无法自行提供的信息或审批时才询问用户。除非你无法运行终端命令，否则不要让用户转去使用以浏览器为主的快速开始流程。
    1. 运行 node --version，确认其报告的 Node.js 版本为 v20.17.0 或更高，优先使用 LTS 版本。
    2. 运行 mint --version。如果该命令不可用，请使用 npm i -g mint 或 pnpm add -g mint 安装 CLI。如果命令成功，请运行 mint update。
    3. 在开始身份验证之前运行 mint status。如果它已显示某个组织，请保留现有会话，不要再创建新账户。
    4. 如果用户已有账户，请运行 mint login。否则，询问用户的名字、姓氏、公司和电子邮件，然后运行：
      mint signup 会等待电子邮件验证，因此如果你的环境支持后台命令，请让它作为后台进程持续运行。告诉用户点击验证链接，并在浏览器中批准 CLI。切勿编造注册信息。
    5. 用户完成验证和引导流程后，再次运行 mint status。确认它报告了用户的电子邮件、组织和子域名。如果组织已存在但未显示子域名，请让用户在引导流程的浏览器标签页中完成选择或连接 GitHub 仓库，然后重试。
    6. 如果用户已有文档仓库，请克隆或打开它，并保留其中的内容。对于新的本地项目，请使用 mint new <directory> --name <name> --theme <theme> 或 mint new <directory> --template <template-name> 在一个新的空目录中生成项目脚手架。如果用户未指定主题或模板，请询问他们想要哪一个。不要在包含用户文件的目录上使用 --force。
    7. 在包含 docs.json 的目录中以后台进程方式运行 mint dev --no-open。确认本地 URL 可以加载，将其告知用户，并在不再需要时停止该进程。
    8. 运行 mint validate 和 mint broken-links。在继续之前，修复由你的更改引起的问题。
    9. 如果项目由 Git 仓库支持且用户要求部署，请提交并推送更改。推送到生产 branch 会触发部署。不要用起始内容覆盖现有仓库。
    10. 运行 mint status 获取已配置的子域名，然后在报告部署完成之前，验证 https://<subdomain>.mintlify.site 可以正常加载。
    仅让用户在浏览器中完成电子邮件验证、OAuth 批准以及连接或授权 GitHub 这些操作。由你负责终端工作流，并在每次用户操作后继续执行。有关命令参数和故障排除，请使用 CLI 命令参考。
  2. 进入您的文档目录。
  3. （可选）将下面的 CLAUDE.md 文件添加到您的项目中。
  4. 运行 claude 启动。
如果想自行连接管理员 MCP： 使用 Claude Code CLI 添加管理员 MCP 服务器：
首次使用时，Claude Code 会打开一个浏览器窗口以完成 OAuth 登录。完成认证后，Claude Code 会在后续调用中复用该会话。 要确认你的设置是否正常，可向 Claude Code 提问，例如 Summarize the standards from CLAUDE.md and list the Mintlify components you can use。正常运行的会话会引用你的 CLAUDE.md，并从已加载的 skill 中引用 Mintlify 组件（例如 Card、Steps 或 Accordion）。

​
CLAUDE.md 的模板

在文档目录根目录保存一个 CLAUDE.md 文件，帮助 Claude Code 理解你的项目。该文件会基于你的文档标准、偏好和工作流程对 Claude Code 进行训练。更多信息请参阅 Anthropic 文档中的管理 Claude 的记忆。 复制此示例模板，或根据你的文档规范进行调整：

​
示例提示

完成 Claude Code 的设置后，试试以下提示，了解它如何协助处理常见的文档任务。你可以直接复制粘贴这些示例，或根据具体需求进行调整。

​
将笔记转化为完善文档

把粗略草稿转为包含组件和 frontmatter 的规范 Markdown 页面。 示例提示：

​
审阅文档的一致性

获取关于改进样式、格式和组件使用的建议。 示例提示：

​
功能变更时更新文档

在产品迭代中保持文档及时更新。 示例：

​
生成完善的代码示例

创建包含错误处理的多语言示例。 示例提示：

​
扩展 Claude Code

除了手动向 Claude Code 提示外，你还可以将其集成到现有的工作流程中。

​
使用 GitHub Actions 进行自动化

在代码变更时自动运行 Claude Code，保持文档同步更新。你可以在拉取请求 (PR；亦称“合并请求”/Merge Request) 上触发文档审阅，或在 API 发生变化时自动更新示例。

​
多实例工作流

针对不同任务使用独立的 Claude Code 会话——一个用于撰写新内容，另一个用于审阅与质量保证。这样有助于保持一致性，并发现单一会话可能遗漏的问题。

​
团队协作

将优化后的 CLAUDE.md 文件与团队共享，确保所有贡献者遵循一致的文档标准。团队通常会形成项目特定的提示与工作流程，并将其纳入文档实践中。

​
自定义命令

在 .claude/commands/ 中创建可复用的斜杠命令，用于你所在项目或团队常见的文档任务。

​
常见问题

不需要，但它能显著提升输出质量。如果没有 CLAUDE.md，Claude Code 会基于通用上下文工作，可能无法遵循你的特定风格指南、组件偏好或术语规范。CLAUDE.md 文件可以训练 Claude Code 了解你的项目标准，这样你就不需要在每次提示中重复说明。
Claude Code 是一款命令行工具，专为在整个代码仓库范围内执行智能体式、多步骤任务而设计。它非常适合审查所有页面是否缺少替代文本、在每个代码示例中更新参数名称，或检查一组文件的一致性等任务。Cursor 和 Devin Desktop 是基于 IDE 的工具，更适合通过内联建议编辑单个文件。两种方式都可以。正确的选择取决于你的工作是逐个文件还是跨整个仓库。
可以。Claude Code 可以读取你的源代码并生成对应的文档。将其指向一个 API 端点、配置文件或一组函数，让它按照你的 CLAUDE.md 标准生成匹配的文档。请审核和完善输出。自动生成在你将 Claude Code 视为初稿作者而非最终发布者时效果最佳。
将 CLAUDE.md 文件提交到你的文档仓库中。任何克隆该仓库并运行 Claude Code 的人都会自动使用你的项目配置。这使得文档标准在所有贡献者之间保持一致，无需每个人单独设置自己的上下文。

相关主题

使用 Codex 编写文档使用 Cursor 编写文档使用 Devin Desktop 编写文档