開発環境テンプレート
本ガイドラインのコードスタイルに合わせて設定済みの、静的サイト用 Vite・Astro テンプレートと WordPress 用 wp-env テンプレート
新規プロジェクトは、次のテンプレートから開始してください。フォーマッター・リンターが本ガイドラインに合わせて設定されています。
| 静的サイト(Vite) | 静的サイト(Astro) | WordPress(wp-env) | |
|---|---|---|---|
| 対象の案件 | 納品後にクライアントや他社が HTML を編集する静的サイト | 上記以外の静的サイト(2 ページ以上のサイト、CMS などのデータと連携するサイト) | WordPress のテーマ開発 |
| テンプレート名 | vite |
astro |
wordpress |
| フォーマット・静的解析 | Biome、markuplint | Prettier、ESLint、Stylelint | Prettier、ESLint、Stylelint |
いずれも GLANZ-CREATIVE/starter にまとまっています。案件用のフォルダは、次のコマンドでテンプレートを展開して作ります。
pnpm create @glanz-creative/starter <テンプレート名> <フォルダ名>
セットアップと使い方は、starter の README と各テンプレートの README を参照してください。
静的サイトのテンプレートの選び方
次の表を目安に、案件に合うほうを選んでください。納品後にクライアントや他社が HTML を直接編集する場合は、Vite が向いています。複数ページのサイトや、CMS との連携など今後の拡張が見込まれるサイトは、Astro が向いています。
| Vite | Astro | |
|---|---|---|
| 納品後の保守 | クライアントや他社が HTML を直接編集する | 自社で保守する |
| ページ構成 | 1 ページの LP など、ページ間で共有するパーツが少ない | 2 ページ以上で、ヘッダー・フッターなどを共有する |
| 編集に必要な知識 | HTML・CSS・JavaScript | HTML・CSS・JavaScript に加えて、ビルド環境と Astro |
| ルーティング | src/ に置いた HTML ファイルがそのままページになる |
src/pages/ に置いたファイルがページになる。[slug].astro のような動的ルートで、データの件数分のページを 1 つのファイルから生成できる |
| 共通パーツ | 共有する仕組みはない。ヘッダーやフッターを直すときは全ページの HTML を書き換える | 共通パーツはコンポーネントに、ページの骨組みはレイアウトにまとめる。修正は 1 か所で済む |
| メタ情報 | ページごとの HTML に直接書く | タイトルや OGP はレイアウトで組み立て、各ページからは値を渡すだけ |
| 型チェック | なし | TypeScript でコンポーネントに渡す値を検査し、渡し忘れや型の誤りをビルド前に見つけられる |
| データ連携 | なし(HTML を手書きして完結する) | microCMS などのヘッドレス CMS や外部データからページを生成できる |
CSS の拡張
CSS は素の CSS で書く前提で設定されています。Sass を追加する場合は、各テンプレートの README にある導入手順に従ってください。Tailwind CSS の導入は Tailwind CSSを参照してください。