ディレクトリ構成

CLIウィザードの create-astro で生成した新しいAstroプロジェクトには、いくつかのファイルとフォルダが含まれています。その他は自分で作成し、Astroの既存のファイル構成に追加します。

ここでは、Astroプロジェクトがどのように構成されているか、また、新しいプロジェクトに含まれるいくつかのファイルについて説明します。

ディレクトリとファイル

Section titled ディレクトリとファイル

Astroは、プロジェクトのために決められたディレクトリ構成を利用します。すべてのAstroプロジェクトのルートには、以下のディレクトリとファイルを含む必要があります。

  • src/* - プロジェクトソースコード(コンポーネント、ページ、スタイルなど)
  • public/* - コード以外の処理不要のアセット(フォント、アイコンなど)
  • package.json - プロジェクトマニフェスト
  • astro.config.mjs - Astroの設定ファイル(オプション)

ディレクトリツリーの例

Section titled ディレクトリツリーの例

よくあるプロジェクトディレクトリは次のような形です。

├── src/
│   ├── components/
│   │   ├── Header.astro
│   │   └-─ Button.jsx
│   ├── layouts/
│   │   └-─ PostLayout.astro
│   └── pages/
│   │   ├── posts/
│   │   │   ├── post1.md
│   │   │   ├── post2.md
│   │   │   └── post3.md
│   │   └── index.astro
│   └── styles/
│       └-─ global.css
├── public/
│   ├── robots.txt
│   ├── favicon.svg
│   └-─ social-image.png
├── astro.config.mjs
└── package.json

srcディレクトリには、プロジェクトのソースコードのほとんどが格納されています。これには以下が含まれます。

Astroは、src/ 内にあるファイルを処理し、最適化し、バンドルして、ブラウザに表示される最終的なウェブサイトを作成します。 静的な public/ ディレクトリとは違い、src/ 内にあるファイルはAstroによってビルドされ、処理されます。

一部のファイル(Astroコンポーネントなど)は、そのままブラウザに送信されず、静的なHTMLに変換されます。その他のファイル(CSSなど)はブラウザに送信されますが、パフォーマンスのために最適化されたり、他のCSSファイルとバンドルされたりする場合があります。

コンポーネントは、HTMLページで再利用可能なコードの単位です。Astroコンポーネントや、ReactやVueなどのフロントエンドコンポーネントがこれにあたります。 プロジェクトのすべてのコンポーネントをこのフォルダにまとめて整理するのが一般的です。

これはAstroプロジェクトでは一般的な慣習ですが、必須ではありません。好きなようにコンポーネントを整理してください!

レイアウトは、いくつかのコンテンツをより大きなページレイアウトで包む、特別な種類のコンポーネントです。これらは、AstroページMarkdownページで、ページのレイアウトを定義するためによく使用されています。

src/components と同様に、このディレクトリは一般的な慣習ですが、必須ではありません。

ページは、サイト上に新しいページを作成するために使用される、特別な種類のコンポーネントです。ページは、Astroコンポーネントまたは、サイトのコンテンツのページを表すMarkdownファイルになります。

CSSやSassのファイルを src/styles ディレクトリに格納するのは一般的な慣習ですが、必須ではありません。スタイルが src/ ディレクトリのどこかにあり、正しくインポートされていれば、Astroはそれらを処理し最適化します。

public/ ディレクトリは、Astroのビルドプロセスで処理する必要のないファイルやアセットを格納するためのものです。これらのファイルは、そのままビルドフォルダにコピーされます。

この動作により、public/ は画像やフォントなどの一般的なアセット、あるいは robots.txtmanifest.webmanifest などの特殊なファイルを置くのに最適な場所となります。

CSSやJavaScriptを public/ ディレクトリに置くことはできますが、これらのファイルは最終的なビルドではバンドルされず、最適化されないことに注意してください。

これは、JavaScriptのパッケージマネージャーが依存関係を管理するために使用するファイルです。また、Astroを実行するためによく使われるスクリプトを定義します(ex: npm start, npm run build)。

あなたのプロジェクトに新しい package.json ファイルを作成する方法については、手動セットアップの説明を参照してください。

このファイルはすべてのスターターテンプレートで生成され、Astroプロジェクトの設定オプションが含まれています。ここでは、使用するインテグレーション、ビルドオプション、サーバーオプションなどを指定できます。

設定の詳細については、設定リファレンスを参照してください。