AI 编码助手和 skill.md

使用 GitBook 官方的 skill.md 文件，让你的 AI 编码助手了解 GitBook 的功能和块

GitBook 提供了一个 skill.md 文件，教 AI 编码助手如何正确编辑 GitBook 文档。将其作为在本地编辑 GitBook 文档时的“项目规则”。

这非常适合 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 编码助手中可为其提供有关为你的 GitBook 文档创建、编辑和格式化内容所需的信息。这意味着助手将遵循已建立的框架和 GitBook 功能的最佳实践。

通过 URL 使用 skill.md

大多数 AI 编码助手支持特定于项目的说明。你可以在项目配置中通过提供 skill 文件的 URL 来引用该文件，以便助手了解如何处理 GitBook 语法。

在本地使用 skill.md

你也可以下载该 skill 文件并将其包含在你的仓库中。首先，将 skill.md 下载到仓库根目录，然后在你的编码助手的规则文件中引用它： “在仓库根目录读取 skill.md 以获取 GitBook 语法和最佳实践” .

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

记得在 GitBook 添加新功能时更新你本地仓库中的最新 skill.md 文件。

测试 AI 生成的内容

你始终需要审查并测试 AI 助手生成的内容——无论是技术准确性还是格式是否正确。

在使用基于 skill 文件训练的 AI 助手时，你应当：

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

• 检查所有内部链接是否可用

• 确认 frontmatter 是否为有效的 YAML

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

注意： AI 助手有时可能会生成不正确的语法或忘记关闭自定义区块。提交前务必审查更改。

GitBook Agent

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

Agent 拥有你文档的完整上下文，且已接受如何以最佳方式使用 GitBook 区块和功能的训练。Agent 帮助你起草内容、进行更新，并在 GitBook 应用内为不同使用场景优化你的文档。

了解 GitBook Agent