ディレクトリ構成

このガイドでは、Starlightプロジェクトの構成と、プロジェクト内のさまざまなファイルの役割について説明します。

Starlightプロジェクトは、基本的に他のAstroプロジェクトと同じファイル・ディレクトリ構成に従います。詳細については、Astroのディレクトリ構成のドキュメントを参照してください。

ファイルとディレクトリ

• astro.config.mjs — Astroの設定ファイルで、ここにStarlightのインテグレーションや設定を記述します。
• src/content/config.ts — コンテンツコレクションの設定ファイルで、Starlightのフロントマタースキーマをプロジェクトに追加します。
• src/content/docs/ — コンテンツのファイルが置かれます。Starlightは、このディレクトリ内の各.md、.mdx、.mdocファイルを、サイトのページへと変換します。
• src/content/i18n/（任意） — 国際化をサポートするための翻訳データが置かれます。
• src/ — プロジェクトの他のソースコードやファイル（コンポーネント、スタイル、画像など）が置かれます。
• public/ — Astroによって処理されない静的アセット（フォント、ファビコン、PDFなど）が置かれます。

プロジェクトの中身の例

Starlightプロジェクトのディレクトリは、次のようになります。