11ty/buildawesome：README に基づく導入ガイド

11ty/buildawesome の README はプロジェクトを「A simpler site generator. Transforms a directory of templates (of varying types) into HTML.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「Build Awesome (Eleventy) 🕚⚡️🎈🐀」には次の説明があります。A simpler static site generator. An alternative to Jekyll. Written in JavaScript. Transforms a directory of templates (of varying types) into HTML.。これは範囲の説明であり、本番検証の結果ではありません。

README の「➡ Documentation」にある内容から、用途が合うかを先に判断できます。Follow us on Mastodon @11ty@neighborhood.11ty.dev。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。Follow us on Mastodon @11ty@neighborhood.11ty.dev。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。

動作の説明は「Tests」など複数の箇所に分かれています。確認できる情報は次の通りです。We have a few test suites, for various reasons:。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。

初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 npm install @awesome.me/buildawesome --save-dev # Backwards compatible here too: npm install @11ty/eleventy --save-dev 実行可能なコマンドがない場合は手順を作らず、「➡ Documentation」で依存関係、待受ポート、初回設定を確認します。

日常運用は公式文書の範囲に限ります。「Build Awesome (Eleventy) 🕚⚡️🎈🐀」にはA simpler static site generator. An alternative to Jekyll. Written in JavaScript. Transforms a directory of templates (of varying types) into HTML.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはFollow us on Mastodon @11ty@neighborhood.11ty.devともあります。

制約も確認が必要です。現在の資料からは、11ty/buildawesome の互換表、性能基準、サービス保証、長期サポートを確認できません。README の記載は「Works with HTML, Markdown, JavaScript, Liquid, Nunjucks, with addons for WebC, Sass, Vue, Svelte, TypeScript, JSX, and many others!」です。不明点は採用記録の検証項目として残し、断定に変えないでください。