テーマの初期セットアップ

はじめに、まず npm install または pnpm install で必要なパッケージをすべてインストールし、続いて npm run build または pnpm build で初回ビルドを実行して、セットアップが正しく動作することを確認します。
サイト内検索用の Pagefind ビルドを、開発環境から利用できる場所にコピーします。手順は OS によって異なります。役立つコマンドをいくつか用意しました。
- Windows の場合は npm run winsearch を実行してください
- OSX または Linux の場合は npm run osxsearch を実行してください
次に、サイトの i18n 設定（単一言語または複数言語）を構成します。npm run docs:config-i18n コマンドを実行し、スクリプトの指示に従ってセットアップしてください。
これで、サイトを好みに合わせて自由に設定できます。

コードツアー

コードベースを理解しやすくするために、いくつかのコードツアーを用意しました。VSCode などの IDE で表示するには、Code Tour 拡張機能が必要です。

コードの大半は src/docs ディレクトリ配下にまとめられています。このため、既存のプロジェクトにフォルダーごと配置するだけで、数分でドキュメント機能を追加できます。

サイト全体の設定は src/docs/config/ フォルダーで行います。翻訳を扱いやすくするため、ほとんどの設定は言語ごとのフォルダーに配置されています。

src/docs/config/siteSettings.json.ts ファイルでサイトの設定を行います。ビュートランジションを有効にするかどうか、アニメーションを有効にするかどうか、ドキュメントの見出しにリンクコピーボタンを表示するかどうかなどが含まれます。

src/docs/config/[language]/siteData.json.ts ファイルでサイトのデータを設定します。サイトのタイトル、説明、ソーシャルリンク、デフォルト画像などが含まれます。

上部ナビゲーションバーのナビゲーションデータは src/docs/config/[language]/navData.json.ts ファイルで設定します。

ドキュメントのセクションの並び順は src/docs/config/[language]/sidebarNavData.json.ts ファイルで設定します。

Google などのロボットに正しいサイトマップを認識させるには、public/robots.txt ファイルを編集して自分のサイトのドメインを指定してください。

Astro は src/pages/ ディレクトリ内の .astro ファイルまたは .md ファイルを探します。各ページはファイル名にもとづくルートとして公開されます。

src/components/ に特別な仕組みはありませんが、Astro / React / Vue / Svelte / Preact のコンポーネントはここに置くことにしています。

画像などの静的アセットは public/ ディレクトリに配置できます。Astro のアセット機能で画像を最適化する場合は、src/assets もよく使用します。

コマンドはすべて、ターミナルからプロジェクトのルートで実行します。

コマンド	動作
`npm install`	依存関係をインストールします
`npm run dev`	`localhost:4321` でローカル開発サーバーを起動します
`npm run build`	本番用サイトを `./dist/` にビルドします
`npm run preview`	デプロイ前にビルドをローカルでプレビューします
`npm run astro ...`	`astro add` や `astro check` などの CLI コマンドを実行します
`npm run astro -- --help`	Astro CLI の使い方のヘルプを表示します

ドキュメントを確認するか、Discord サーバーに参加してみてください。