Agentスキル

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は、このトークンをGitBookスキルで作業する際のエージェント認証に使用します。

2

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

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

npx skills add GitBookIO/gitbook-skills

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

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

1

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

エージェントがGitBookとやり取りできるようにするには、 アクセストークンを作成する GitBookの開発者設定から作成する必要があります。GitBookは、このトークンをGitBookスキルで作業する際のエージェント認証に使用します。

2

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

GitBookスキルを次でインストールする npx skills add GitBookIO/gitbook-skills アシスタントが対応している場合。

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

スキル	説明	ダウンロード
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

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

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

よくある質問

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

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

含まれる内容：

• カスタムブロック用の完全な構文リファレンス。
• 設定ファイル形式。含まれるもの： .gitbook.yaml, SUMMARY.mdを読み取り、 .gitbook/vars.yaml.
• frontmatterオプション、レイアウト制御、変数、式、決定表、およびよくある落とし穴。

AI生成コンテンツをどうテストしますか？

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

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

アシスタントがSKILL.mdを使っているかどうかはどう確認しますか？

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

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

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

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

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

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

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

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

まず一般的な失敗箇所を確認してください：

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

コミットする前に、必ずGitBookで出力をレビューしてください。

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

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

を使ってローカルでファイルを編集しているだけなら SKILL.md、アシスタントをGitBookのワークフローやAPIに接続するまで不要な場合があります。

スキルが古く見える場合はどうしますか？

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

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