AIコーディングアシスタントとskill.md

GitBook公式のskill.mdファイルを使って、AIコーディングアシスタントにGitBookの機能やブロックに関する知識を与えます

GitBook は skill.md ファイルを提供しています。これは、AI コーディングアシスタントに GitBook のドキュメントを正しく編集する方法を教えるものです。GitBook のドキュメントをローカルで編集する際の「プロジェクトルール」として使用してください。

これは Git 同期 ドキュメントをローカルで編集し、その後変更をコミットしてドキュメントサイトを更新するワークフローとよく合います。参照用ファイルには、GitBook の Markdown 拡張、カスタムブロック、設定ファイル、ベストプラクティスが含まれています。

ダウンロード

27KB

skill.md

開く

GitBook エディタで AI を使って書くほうがよいですか？

GitBook では、 GitBook エージェント エディタ内から 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 エージェント

GitBook で直接作業するほうがよいですか？ GitBook エージェント Git Sync を使うかどうかにかかわらず、GitBook エディタで AI 支援ワークフローを利用できます。

Agent はドキュメント全体のコンテキストを把握しており、GitBook のブロックや機能を最適に使う方法についてすでに学習しています。Agent は、GitBook アプリ内からコンテンツの下書き作成、更新、さまざまなユースケース向けのドキュメント最適化を支援します。

GitBook Agent を見る