Preset の規約
本セクションは、@tuqulore-inc/eleventy-preset を使ってサイトを書くときに従うべき規約を扱います。「どう書くか」に閉じ、実装がどのプラグイン由来かは意識しなくて済むように書きます。実装の内部設計は Plugins 章を参照してください。
何を規約として持ち込むか
プリセットは、次の 3 つの領域に規約を持ち込みます。
- ディレクトリと命名:
src/,dist/,_data/,_includes/,public/のディレクトリ構成と、.mdx/.jsx/.client.jsxの命名規約。静的アセットと画像最適化の扱いも扱います。 - テンプレート: YAML frontmatter によるページデータの受け渡し、
layoutプロパティ、レイアウトチェイニングの書き方。 - Data Access:
eleventyシングルトンから site / nav / page / title / content を参照する書き方。
API の詳細と設計の背景
preset()の呼び出しや extend の受け取り、含まれるプラグインなど、API リファレンスは@tuqulore-inc/eleventy-presetの README を参照してください。- 「なぜこの規約なのか」の設計背景は Architecture を参照してください。