GitBook 公式の skill.md ファイルを使って、AI コーディングアシスタントに GitBook の機能やブロックの知識を与えます
GitBook は skill.md というファイルを提供しており、AI コーディングアシスタントに GitBook のドキュメントを適切に編集する方法を教えます。GitBook のドキュメントをローカルで編集する際は、これを「プロジェクトルール」として使用してください。
これは Git Sync ローカルでドキュメントを編集し、その変更をコミットしてドキュメントサイトを更新するワークフローとよく合います。この参照ファイルには、GitBook の Markdown 拡張、カスタムブロック、設定ファイル、ベストプラクティスが含まれています。
GitBook エディタで AI を使って書く方が好みですか？
GitBook では、 GitBook Agent エディタから直接、AI 支援によるドキュメント作成機能も提供しています。このガイドは、Claude Code や Cursor のような外部コーディングアシスタントを使うことを好むチーム向けです。
すべてのカスタムブロックの完全な構文リファレンス
設定ファイル形式（.gitbook.yaml, SUMMARY.md, .gitbook/vars.yaml)
Frontmatter のオプションとレイアウト制御
変数と式の構文
適切なブロックタイプを選ぶための判定表
よくある落とし穴とベストプラクティス
このファイルを AI コーディングアシスタントに追加すると、GitBook ドキュメント向けのコンテンツを作成、編集、整形するために必要な情報を与えられます。つまり、アシスタントは GitBook の機能に対して確立されたフレームワークとベストプラクティスに従うようになります。
ほとんどの AI コーディングアシスタントは、プロジェクト固有の指示に対応しています。skill ファイルの URL を指定して、プロジェクト設定で skill ファイルを参照すれば、アシスタントは GitBook の構文の扱い方を理解できます。
skill ファイルをダウンロードして、リポジトリに含めることもできます。まず skill.md をリポジトリのルートにダウンロードし、その後コーディングアシスタントのルールファイルで参照してください。 「リポジトリのルートにある skill.md を読んで、GitBook の構文とベストプラクティスを確認してください」 .
この方法はオフラインでも動作し、チームごとの変更も可能です。
GitBook に新機能が追加されるたびに、ローカルのリポジトリを最新の skill.md ファイルで更新することを忘れないでください。
AI アシスタントが生成したコンテンツは、技術的な正確性と適切な書式の両方について、必ずレビューしてテストすることが重要です。
skill ファイルで学習した AI アシスタントを使う場合は、次の点を確認してください。
カスタムブロックが GitBook で正しくレンダリングされることを確認する
すべての内部リンクが機能することを確認する
frontmatter が有効な YAML であることを確認する
変数が正しいスコープを参照していることをテストする
注： AI アシスタントは、誤った構文を生成したり、カスタムブロックの閉じ忘れをしたりすることがあります。コミットする前に、必ず変更をレビューしてください。
GitBook 上で直接作業する方が好みですか？ GitBook Agent Git Sync を使うかどうかにかかわらず、GitBook エディタで AI 支援ワークフローを提供します。
Agent はドキュメント全体のコンテキストを把握しており、GitBook のブロックと機能を最適に使う方法もすでに学習しています。Agent は、GitBook アプリ内だけでコンテンツの下書き、更新、さまざまなユースケース向けのドキュメント最適化を支援します。
最終更新
役に立ちましたか？
役に立ちましたか？
