静的 HTML ジェネレータを作ってみる

※ まだ作ってないです

きっかけ

• 世の中には既にいろいろな静的 HTML ジェネレータがある
• ただ、このサイトを作るのにちょうどいいものがなかった
• 結局自分で作っている
• だったら他にも同様の人はいるのでは？
• ということで今作っている HTML ジェネレータをもう少し汎用的にして公開すれば多少の需要があるのでは？
• 需要がないにしても、汎用的にすることで自分自身メンテナンスが楽になるのでは？

方向性

• ゲーム制作者やエンジニア向けのツール
• HTML, CSS, JavaScript の知識があることを前提にする
• GitHub, npm が使えることを前提にする
• WordPress の複雑さに疲れている人を対象にする
• WordPress のエディタではなく普段自分が使っているエディタで書きたい人を対象にする
• 共同編集のことは考えない (GitHub に任せる)

仕様

• Markdown ファイル一枚から複数の HTML を作成する
• 完全に静的な HTML ファイルを生成する
• サイトマップを自動で作成してくれる
• 目次も自動で作成。オプションで ON / OFF 切り替え。
• 記事一覧ページを自動で作成。
• 検索画面を自動で作成。
• ヘッダー、フッター、スタイルシート等は自由に編集可能。
• EJS テンプレートを使用
• 既存のサイトに簡単に組み込みできる
• ビルドシステムには依存しない
• ひとつのコマンドだけで操作する
• Markdown の拡張記法はどんどん取り入れる
• npm コマンド一発でインストールして使い始めることができる
• ドキュメントのバージョン管理は GitHub に任せる。共同編集も同様。
• 「トップページ」「固定ページ」「記事」という考え方はやめる。すべてが記事ページ。
• オプションは JSON ファイルに書く
• 最終更新日を記録するために何らかのログファイルを置く必要がある

売り

• 静的 HTML なのに検索機能が使える
• デフォルトで Markdown の拡張機能がいろいろ使える

イメージ

インストール

npm install -g simple-static-html-generator

初期化

simple-static-html-generator init

生成

simple-static-html-generator generate

デプロイ

simple-static-html-generator deploy

監視

simple-static-html-generator watch