鏡 (Kagami)A Minimal Static Site Generator
Markdown を静的サイトに変換する、最小限の SSG。
鏡は単一のバイナリで動作する静的サイトジェネレーターです。設定ファイルは要らず、kagami を実行するだけで、カレントディレクトリの .md ファイルを HTML に変換します。
なぜ作ったのか
既存の SSG は機能が多すぎます。テーマシステム、プラグインアーキテクチャ、複雑な設定ファイル。個人ブログを書くだけなら、こんなものは要らないはずです。
鏡は「ファイルを HTML に変換する」という一つのことだけをします。
主な特徴
- ゼロ設定。設定ファイルは存在しません。
- 単一バイナリ。Go 製、約 5 MB、依存なし。
- 日本語フレンドリー。縦書き、ルビ、約物の処理を組み込み済み。
- 高速。1,000 ファイルを 200ms で処理します。
- ライブリロード。
kagami serveで開発サーバが起動します。
クイックスタート
# インストール
brew install kagami-ssg/tap/kagami
# 変換
kagami build .
# 開発サーバ
kagami serve --port 4000kagami init でテンプレートを生成することもできます。
比較
| ツール | 設定ファイル | 日本語処理 | バイナリサイズ |
|---|---|---|---|
| Hugo | 必要 | 限定的 | 約 30 MB |
| Jekyll | 必要 | プラグインで | Ruby 依存 |
| Eleventy | 必要 | プラグインで | Node 依存 |
| 鏡 | 不要 | 組み込み | 約 5 MB |
ステータス
現在 v0.3 です。日常的に使われていますが、v1.0 までは破壊的変更があり得ます。
ライセンス
MIT。詳細は LICENSE を参照してください。
夜中の三時にデプロイを直したくない人のための SSG。