コンテンツにスキップ

スキルの作成

スキルの作成は非常に簡単です。通常の Starlight ドキュメントページを作成し、フロントマターにいくつかの専用フィールドを追加するだけです。

ドキュメントページのフロントマターに skill: true を宣言することで、そのページをスキルとしてマークします。マークされたページは通常のドキュメントとしても機能しつつ、ビルド時に AI スキルとして処理されます。

ページの本文は、そのままスキルの本文として配布されます。 本文を AI 向けに絞り込むような特殊な仕組みは提供していません。ひとつのソースコードを人間とAIで共有します。

Markdown または MDX ファイルのフロントマターで、以下のフィールドを使用できます。

フィールド必須説明
skilltrue を指定してスキルとしてマークします。
description人が読めるスキルの説明文。カタログやスキル配布ファイルに使用されます。
title推奨ページタイトル。スキル名が未指定の場合、ここから自動導出されます。
skill-nameスキル名(機械可読な識別子)の明示指定。
skill-category/ 区切りの階層パス文字列(例: development/frontend)による明示的なカテゴリ指定。
skill-licenseライセンス名(例: MIT)。
skill-compatibility動作環境やバージョン互換性の説明(最大 500 文字)。
skill-metadataスキル配布ファイルに転記される任意の Key-Value 文字列情報。
skill-allowed-toolsスペース区切りの事前承認済みツール識別子リスト。

(注: スキーマやコードスニペットといった別ファイルの参照には subfiles フィールドを利用します。詳細は「付随ファイル」の章をご覧ください)

スキルとして各種情報を網羅したフロントマターのフルサイズな例を示します。

---
title: "React コンポーネント規約"
description: "このプロジェクトにおける React コンポーネント新規作成時のルールとベストプラクティス。"
skill: true
skill-name: "react-components"
skill-category: "frontend/react"
skill-license: "MIT"
skill-compatibility: "React 18.x / TypeScript 環境"
skill-allowed-tools: "Bash(git:*) Read Write"
skill-metadata:
version: "1.2.0"
author: "フロントエンドチーム"
subfiles:
- "schemas/component.json"
---

スキル名は機械が読み取るための識別子であり、サイト内で一意である必要があります。重複した場合はビルドエラーとなります。

  • 使用可能文字: 英小文字(a-z)、数字(0-9)、ハイフン(-)のみ。
  • 文字数: 1 〜 64 文字。
  • 制約: 先頭・末尾のハイフン、および連続ハイフン(--)は不可。

カテゴリはサイドバーでのネストやカタログ上でのグループ化に使用されます。以下の順序で解決されます:

  1. skill-category フィールド(明示指定)
  2. autoCategoryMode 設定に基づく自動導出(ファイルパス由来)
  3. 空文字列(未分類)