エージェントスキル

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 スキルを追加する

AI コーディングアシスタントがパッケージベースのスキルをサポートしている場合は、このオプションを使用してください。

1

アクセス トークンを作成する

エージェントが GitBook とやり取りできるようにするには、 アクセス トークンを作成する 必要があります。GitBook は、このトークンを使って、GitBook スキルを扱う際にエージェントを認証します。

2

GitBook スキルをインストールする

このスキルは gitbook-skills リポジトリの一部です。次のコマンドを実行して、GitBook スキルをプロジェクトに直接インストールしてください：

npx skills add GitBookIO/gitbook-skills

GitBook スキルをローカルに追加する

アシスタントがパッケージベースのスキルをサポートしていない場合は、GitBook のスキルをダウンロードしてください。

1

アクセス トークンを作成する

エージェントが GitBook とやり取りできるようにするには、 アクセス トークンを作成する 必要があります。GitBook は、このトークンを使って、GitBook スキルを扱う際にエージェントを認証します。

2

GitBook スキルをダウンロードする

GitBook スキルを次の方法でインストール npx skills add GitBookIO/gitbook-skills アシスタントが対応している場合に使用してください。

ファイルを手動でプロジェクトにコピーするには、次の gitbook-skills リポジトリから GitBook スキルを取得してください。

スキル	説明	ダウンロード
configure-site	GitBook のドキュメントサイト全体を作成・維持します。	GitHub
write-docs	GitBook のドキュメントページを作成、執筆、編集、整形します。	GitHub
write-openapi	OpenAPI/Swagger の API リファレンス ドキュメントを作成、設定、構成、トラブルシュートします。	GitHub
build-integration	GitBook 用のカスタム統合を構築します。	GitHub
cr-create	GitBook の変更リクエストを作成し、コンテンツをプッシュし、レビューを依頼し、コメントに対応します。	GitHub
cr-review	GitBook の変更リクエストをレビューし、変更点を要約し、コメントし、承認するか、変更を依頼します。	GitHub

GitBook に新機能が追加されたら、必ずローカルのリポジトリを最新の SKILL.md ファイルで更新することを忘れないでください。

GitBook スキルの使用方法

Scaffold a Git-synced docs site from a folder of markdown

Upgrade a plain markdown page into a polished GitBook page

Generate an API reference from an OpenAPI spec

FAQ

SKILL.md には何が含まれていますか？

SKILL.md AI コーディングアシスタントが、GitBook コンテンツを正しく作成、編集、整形するために必要なコンテキストを提供します。

含まれるもの：

• カスタムブロックの完全な構文リファレンス。
• 設定ファイル形式。たとえば .gitbook.yaml, SUMMARY.md、そして .gitbook/vars.yaml.
• フロントマターのオプション、レイアウト制御、変数、式、決定表、よくある落とし穴。

AI が生成したコンテンツはどうテストすればよいですか？

AI アシスタントが生成したコンテンツは、必ずレビューしてテストしてください。スキルファイルで学習したアシスタントを使う場合：

• カスタムブロックが GitBook で正しくレンダリングされることを確認してください。
• すべての内部リンクが機能することを確認してください。
• フロントマターが有効な YAML であることを確認してください。
• 変数が正しいスコープを参照していることをテストしてください。

アシスタントが SKILL.md を使っているかどうすれば分かりますか？

GitBook ページをどのように整形するか説明するように依頼してみてください。

GitBook のブロック、フロントマター、変数、または次のようなファイルに言及しているなら SUMMARY.md、スキルは読み込まれています。

一般的な Markdown だけで答える場合は、プロジェクト ルールを確認してアシスタントを再読み込みしてください。

なぜアシスタントは GitBook 固有の構文を無視するのですか？

通常、これはスキルファイルが読み込まれていないか、ルールが十分に具体的でないことを意味します。

アシスタントが SKILL.md をリポジトリのルートから読み込むか、プロジェクトの指示で GitHub の URL を使用していることを確認してください。

アシスタントが指示をキャッシュする場合は、ルールを追加または更新した後にセッションを再起動してください。

アシスタントが無効な GitBook コンテンツを生成したらどうなりますか？

まず、よくある失敗箇所を確認してください：

• 閉じていないカスタムブロック
• フロントマター内の無効な YAML
• 壊れた変数参照
• ページ構成と一致しないリンク

コミットする前に、必ず GitBook で出力を確認してください。

それでもアクセス トークンは必要ですか？

エージェントが GitBook と直接やり取りする場合は、アクセス トークンが必要です。あなたの 開発者設定.

ローカルでファイルを編集しているだけなら SKILL.md、アシスタントを GitBook のワークフローや API に接続するまでは不要かもしれません。

スキルが古いように見える場合は？

ローカルの SKILL.mdを更新するか、アシスタントを GitHub のソースに戻してください。

チームがファイルの一部をカスタム ルールにコピーしている場合は、それらも更新してください。