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

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

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

これは次とよく合います： Git Sync ワークフローではドキュメントをローカルで編集してから変更をコミットしてドキュメントサイトを更新します。参照ファイルには GitBook のマークダウン拡張、カスタムブロック、設定ファイル、およびベストプラクティスが含まれます。

ダウンロード

27KB

skill.md

開く

GitBook エディタで AI と一緒に書く方が良いですか？

GitBook はまた提供しています： GitBook Agent エディタから直接 AI 支援のドキュメント作成を行うためのものです。本ガイドは Claude Code や Cursor のような外部コーディングアシスタントを使うことを好むチーム向けです。

skill.md に含まれる内容

• すべてのカスタムブロックの完全な構文リファレンス

• 設定ファイル形式（.gitbook.yaml, SUMMARY.md, .gitbook/vars.yaml)

• フロントマターのオプションとレイアウト制御

• 変数と式の構文

• 適切なブロックタイプを選ぶための意思決定表

• 一般的な落とし穴とベストプラクティス

このファイルを AI コーディングアシスタントに追加すると、GitBook ドキュメントの作成、編集、フォーマットに必要な情報が提供されます。これによりアシスタントは GitBook の機能に対する確立されたフレームワークとベストプラクティスに従うようになります。

URL 経由で skill.md を使用する

ほとんどの AI コーディングアシスタントはプロジェクト固有の指示をサポートしています。スキルファイルへの URL をプロジェクト構成で参照することで、アシスタントが GitBook の構文に従って作業する方法を把握できます。

skill.md をローカルで使用する

スキルファイルをダウンロードしてリポジトリに含めることもできます。まず skill.md をリポジトリのルートにダウンロードし、その後コーディングアシスタントのルールファイルで参照してください： "リポジトリルートの skill.md を読み、GitBook の構文とベストプラクティスを参照する" .

この方法はオフラインでも動作し、チーム固有の変更を可能にします。

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

AI が生成したコンテンツのテスト

AI アシスタントが生成したコンテンツは、技術的な正確さと適切なフォーマットの両方について常にレビューおよびテストすることが重要です。

skill ファイルで学習した AI アシスタントと作業する場合は、次を行ってください：

• カスタムブロックが GitBook で正しくレンダリングされることを確認する

• すべての内部リンクが機能することを確認する

• フロントマターが有効な YAML であることを確認する

• 変数が正しいスコープを参照していることをテストする

注意： AI アシスタントは時折誤った構文を生成したり、カスタムブロックの閉じ忘れをすることがあります。コミットする前に必ず変更をレビューしてください。

GitBook Agent

直接 GitBook で作業する方が良いですか？ GitBook Agent は、Git Sync を使用しているかどうかに関係なく、GitBook エディタ内で AI 支援のワークフローを提供します。

Agent はあなたのドキュメントの完全なコンテキストを把握しており、GitBook のブロックや機能を最適な方法で使用する方法について既に学習しています。Agent は GitBook アプリ内からコンテンツの草案作成、更新、およびさまざまなユースケースに合わせたドキュメントの最適化を支援します。

GitBook Agent を発見する