Package Exports
- minista
- minista/client
Readme
minista
Site & Documentation
About
minista(ミニスタ)は React の JSX から綺麗な HTML を作るスタティックサイトジェネレーターです。
- すべての機能を Vite プラグインとして提供
- ビルド時に自動で Vite の「SSR ビルド + 通常ビルド」を実行
How To Use
Automatic Setup
$ npm create minista@latest
Manual Setup
$ npm install --save-dev minista vite react react-dom
$ touch ./minista.config.js
$ touch ./src/pages/index.jsx
// ./minista.config.js
import { pluginSsg } from "minista"
export default {
plugins: [pluginSsg()],
}
// ./src/pages/index.jsx
export default function () {
return <h1>Hello!</h1>
}
package.json
を開き、以下のスクリプトを追加します。
"scripts": {
"dev": "minista",
"build": "minista build",
"preview": "minista preview",
}
Commands
Vite の CLI コマンドとオプションがすべて使えます。
コマンド | 内容 |
---|---|
minista [root] |
開発モード(Ctrl + C で停止) |
minista build [root] |
静的書き出し |
minista preview [root] |
静的書き出し後の動作確認 |
minista 独自のオプション | 内容 |
---|---|
--oneBuild |
minista のビルドを 1 回に制限する |
Config
Vite の設定がすべて使えます。コンフィグファイルは minista.config.{ts,js}
・vite.config.{ts,js}
のどちらでも動作し、defineConfig
も使用できます。
// ./minista.config.ts
import { defineConfig, pluginSsg } from "minista"
export default defineConfig({
plugins: [pluginSsg()],
})
Plugins
minista の各機能は同封されているプラグインをコンフィグに登録することで動作します。使い方は各ディレクトリの README.md を参照ください。
- pluginSsg: JSX を静的な HTML に変換
- pluginBundle: CSS・JS・画像をビルドプロセスに乗せる
- pluginMdx: MDX・Markdown の変換に対応
- pluginImage: 画像を最適化・リモート画像をダウンロード
- pluginSvg: SVG ファイルを HTML にインラインで展開
- pluginSprite: SVG ファイルを スプライト化して出力
- pluginBeautify: ビルド時に HTML・CSS・JS を整形
- pluginArchive: ビルド時に圧縮ファイルを生成
License
- MIT