Agent 技能
使用 GitBook 官方的 SKILL.md 文件，让 Claude Code、Cursor 或 Codex 等 AI 编程助手了解 GitBook 的功能和块
最后更新于
这有帮助吗？
使用 GitBook 官方的 SKILL.md 文件，让 Claude Code、Cursor 或 Codex 等 AI 编程助手了解 GitBook 的功能和块
GitBook 提供 技能文件 这些文件教 AI 编程助手如何正确编辑 GitBook 文档。如果你使用 Claude Code、Cursor、Codex 或其他外部编程助手，请添加 GitBook 技能，以便你的代理能够使用 GitBook 语法、块和配置文件。
这与 Git Sync 工作流非常契合——在你的仓库中进行更改，提交后，你的文档站点会自动更新。
更喜欢在 GitBook 编辑器中写作？使用 GitBook Agent 即可在不离开 GitBook 的情况下起草、改写、审阅和翻译内容。
当你的 AI 编程助手支持基于包的技能时，请使用此选项。
要让你的代理与 GitBook 交互，你需要 创建访问令牌 ，通过 GitBook 开发者设置生成。GitBook 会使用此令牌在你的代理使用 GitBook 技能时进行身份验证。
此技能是 gitbook-skills 仓库的一部分。运行以下命令可将 GitBook 技能直接安装到你的项目中：
如果你的助手不支持基于包的技能，请下载 GitBook 的技能。
要让你的代理与 GitBook 交互，你需要 创建访问令牌 ，通过 GitBook 开发者设置生成。GitBook 会使用此令牌在你的代理使用 GitBook 技能时进行身份验证。
使用以下方式安装 GitBook 技能 npx skills add GitBookIO/gitbook-skills ，当你的助手支持它时。
要手动将文件复制到你的项目中，请从 gitbook-skills 仓库获取 GitBook 技能。
请记得在 GitBook 添加新功能时，更新你的本地仓库中的最新 SKILL.md 文件。
SKILL.md 为你的 AI 编程助手提供所需上下文，使其能够正确创建、编辑和格式化 GitBook 内容。
它包括：
自定义块的完整语法参考。
配置文件格式，包括 .gitbook.yaml, SUMMARY.md，以及 .gitbook/vars.yaml.
frontmatter 选项、布局控制、变量、表达式、决策表以及常见陷阱。
始终审阅并测试 AI 助手生成的内容。在使用基于技能文件训练的助手时：
验证自定义块是否在 GitBook 中正确渲染。
检查所有内部链接是否可用。
确认 frontmatter 是有效的 YAML。
测试变量是否引用了正确的作用域。
让它解释它会如何格式化一个 GitBook 页面。
如果它提到了 GitBook 块、frontmatter、变量，或者像 SUMMARY.md这样的文件，说明技能已加载。
如果它只回答通用 Markdown，请检查你的项目规则并重新加载助手。
这通常意味着技能文件未加载，或者规则不够具体。
确保你的助手从 SKILL.md 仓库根目录读取，或者在项目说明中使用 GitHub URL。
如果助手会缓存指令，在你添加或更新规则后重启会话。
先检查常见故障点：
未闭合的自定义块
frontmatter 中无效的 YAML
损坏的变量引用
与页面结构不匹配的链接
在提交之前，务必先在 GitBook 中审阅输出。
当你的代理直接与 GitBook 交互时，你需要访问令牌。你可以在你的 开发者设置.
如果你只是使用 SKILL.md在本地编辑文件，那么在你将助手连接到 GitBook 工作流或 API 之前，可能不需要访问令牌。
最后更新于
这有帮助吗？
这有帮助吗？
npx skills add GitBookIO/gitbook-skills