Getting Started

はじめに

Nagi（なぎ）は、Markdownを書くだけでしずかに速いサイトができる静的サイトジェネレーターです。設定ゼロではじめて、必要になったら少しずつ育てられます。

Note

このサイトはドキュメントテンプレートのデモです。Nagiは架空のツールですが、テンプレートは実際にこのまま使えます。

特徴

Nagiは「書くこと」以外の仕事を増やさないことを大切にしています。

できること	説明
ゼロコンフィグ	設定ファイルなしでビルドできる。`nagi.config.js` は任意
Markdown拡張	コードブロック、目次、コールアウトを標準サポート
高速ビルド	1,000ページを2秒でビルド
テーマ	CSS変数を差し替えるだけの軽量テーマシステム

Node.js 18以降が入っていれば、npmでグローバルに導入できます。

bash

npm install -g nagi

導入できたら、バージョンを確認します。

bash

nagi --version

空のディレクトリで nagi init を実行すると、最小構成が用意されます。

bash

nagi init my-site
cd my-site
nagi dev

nagi dev を起動すると http://localhost:3000 でプレビューが立ち上がり、Markdownを保存するたびに自動でリロードされます。詳しい手順は「クイックスタート」を参照してください。