AI 编码助手和 skill.md

使用 GitBook 官方的 skill.md 文件，让 Claude Code、Cursor 或 Codex 等 AI 编码助手了解 GitBook 的功能和区块

GitBook 提供一个 skill.md 文件，用于教会 AI 编码助手如何正确编辑 GitBook 文档。如果你想使用 Claude Code、Cursor、Codex 或其他外部编码助手在本地编辑 GitBook 文档，请将 skill.md 文件用作“项目规则”。

这与 Git Sync 工作流程非常契合，在这种流程中，你先在本地编辑文档，然后提交更改来更新你的文档站点。参考文件涵盖 GitBook 的 Markdown 扩展、自定义块、配置文件以及面向外部助手的最佳实践。

下载

27KB

skill.md

打开

更喜欢在 GitBook 编辑器中借助 AI 写作？

GitBook 还提供 GitBook Agent ，可直接在编辑器中进行 AI 辅助文档编写。本指南适用于更喜欢使用 Claude Code 或 Cursor 等外部编码助手的团队。

skill.md 包含什么

• 所有自定义块的完整语法参考

• 配置文件格式（.gitbook.yaml, SUMMARY.md, .gitbook/vars.yaml)

• Frontmatter 选项和布局控制

• 变量和表达式语法

• 用于选择正确块类型的决策表

• 常见陷阱和最佳实践

将此文件添加到你的 AI 编码助手（例如 Claude Code、Codex 等）中，可为其提供有关为你的 GitBook 文档创建、编辑和格式化内容所需的信息。这意味着助手会遵循 GitBook 功能的既定框架和最佳实践。

通过 URL 使用 skill.md

大多数 AI 编码助手都支持项目特定说明。你可以在项目配置中通过提供 skill 文件的 URL 来引用它，这样助手就知道如何处理 GitBook 语法。

在本地使用 skill.md

你也可以下载该 skill 文件并将其包含在仓库中。首先，将 skill.md 下载到仓库根目录，然后在你的编码助手的规则文件中引用它： “在仓库根目录中阅读 skill.md，以了解 GitBook 语法和最佳实践” 。这非常适合 Claude Code、ChatGPT、Codex 以及类似工具。

这种方法可离线使用，并允许进行团队特定的修改。

请记得随着 GitBook 添加新功能，及时将本地仓库更新为最新的 skill.md 文件。

测试 AI 生成的内容

确保始终审阅并测试 AI 助手生成的内容——既要检查技术准确性，也要检查格式是否正确。

在使用经过 skill 文件训练的 AI 助手时，你应该：

• 验证任何自定义块是否在 GitBook 中正确渲染

• 检查所有内部链接是否有效

• 确认 frontmatter 是有效的 YAML

• 测试变量是否引用了正确的作用域

注意： AI 助手有时可能会生成错误的语法，或者忘记关闭自定义块。提交前务必审阅更改。

GitBook Agent

更喜欢直接在 GitBook 中工作？ GitBook Agent 无论你是否使用 Git Sync，都能在 GitBook 编辑器中为你提供 AI 辅助工作流。

Agent 拥有你文档的完整上下文，并且已经接受过训练，知道如何以最佳方式使用 GitBook 的块和功能。Agent 可帮助你起草内容、进行更新，并针对不同用例优化文档，所有操作都可在 GitBook 应用内完成。

了解 GitBook Agent