minista 4.0.3 → 4.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,18 +6,18 @@
|
|
|
6
6
|
|
|
7
7
|
## About
|
|
8
8
|
|
|
9
|
-
minista（ミニスタ）は、React
|
|
9
|
+
minista（ミニスタ）は、ReactのJSXとViteで100%静的なサイトを作るスタティックサイトジェネレーターです。
|
|
10
10
|
|
|
11
11
|
## Concept
|
|
12
12
|
|
|
13
|
-
- **すべてを
|
|
14
|
-
- 静的
|
|
15
|
-
- 独自構文を使わず、エディタサポートの優れた
|
|
13
|
+
- **すべてをJSXで書き、綺麗なHTMLを生成！**
|
|
14
|
+
- 静的HTMLが必要なウェブ制作の現場にもJSXのコンポーネント管理を導入したい
|
|
15
|
+
- 独自構文を使わず、エディタサポートの優れたTypeScriptを活用したい
|
|
16
16
|
|
|
17
17
|
## Features
|
|
18
18
|
|
|
19
|
-
- すべての機能を
|
|
20
|
-
- ビルド時に自動で
|
|
19
|
+
- すべての機能をViteプラグインとして提供
|
|
20
|
+
- ビルド時に自動でViteの「SSRビルド+通常ビルド」を実行
|
|
21
21
|
|
|
22
22
|
## Setup
|
|
23
23
|
|
|
@@ -65,21 +65,21 @@ export default function () {
|
|
|
65
65
|
|
|
66
66
|
## CLI
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
|コマンド |内容 |
|
|
69
69
|
| ------------------------ | ---------------------------------------------- |
|
|
70
|
-
| `minista [root]`
|
|
71
|
-
| `minista build [root]`
|
|
72
|
-
| `minista preview [root]`
|
|
70
|
+
| `minista [root]` |開発モード（`Ctrl + C` で停止） |
|
|
71
|
+
| `minista build [root]` |静的書き出し（SSRビルド後に連続で通常ビルド）|
|
|
72
|
+
| `minista preview [root]` |静的書き出し後の動作確認 |
|
|
73
73
|
|
|
74
|
-
[Vite
|
|
74
|
+
[ViteのCLIコマンドオプション](https://ja.vitejs.dev/guide/cli.html)がすべて使えるほか、以下の独自オプションがあります。
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
|独自のオプション|内容 |
|
|
77
77
|
| ---------------- | ------------------------------------------------- |
|
|
78
|
-
| `--oneBuild` | minista
|
|
78
|
+
| `--oneBuild` | ministaのビルドを1回に制限（連続ビルドしない）|
|
|
79
79
|
|
|
80
80
|
## Config
|
|
81
81
|
|
|
82
|
-
[Vite
|
|
82
|
+
[Viteのコンフィグ](https://ja.vitejs.dev/config/)がすべて使えます。コンフィグファイルは `minista.config.{ts,js}`・`vite.config.{ts,js}` のどちらでも動作し、`defineConfig` も使用できます。
|
|
83
83
|
|
|
84
84
|
```ts
|
|
85
85
|
// ./minista.config.ts
|
|
@@ -90,7 +90,7 @@ export default defineConfig({
|
|
|
90
90
|
})
|
|
91
91
|
```
|
|
92
92
|
|
|
93
|
-
minista
|
|
93
|
+
ministaはViteのSSRビルドと通常ビルドを連続で行うため、ビルドの一括設定がエラーに繋がる場合があります。これは設定をSSRビルド用・通常ビルド用に切り分けることで解消できます。
|
|
94
94
|
|
|
95
95
|
```ts
|
|
96
96
|
// ./minista.config.ts
|
|
@@ -106,20 +106,20 @@ export default defineConfig(({ command, isSsrBuild }) => {
|
|
|
106
106
|
|
|
107
107
|
## Plugins
|
|
108
108
|
|
|
109
|
-
minista
|
|
109
|
+
ministaの各機能は同封されているプラグインをコンフィグに登録することで動作します。
|
|
110
110
|
|
|
111
|
-
- [pluginSsg](https://minista.qranoko.jp/docs/plugins/ssg): React
|
|
112
|
-
- [pluginMdx](https://minista.qranoko.jp/docs/plugins/mdx): MDX・Markdown
|
|
113
|
-
- [pluginBundle](https://minista.qranoko.jp/docs/plugins/bundle): JSX
|
|
111
|
+
- [pluginSsg](https://minista.qranoko.jp/docs/plugins/ssg): ReactのJSXを静的なHTMLに変換
|
|
112
|
+
- [pluginMdx](https://minista.qranoko.jp/docs/plugins/mdx): MDX・MarkdownをHTMLの変換に対応させる
|
|
113
|
+
- [pluginBundle](https://minista.qranoko.jp/docs/plugins/bundle): JSX内でimportしたCSS・画像を出力
|
|
114
114
|
- [pluginEntry](https://minista.qranoko.jp/docs/plugins/entry): CSS・JS・画像をビルドプロセスに乗せる
|
|
115
|
-
- [pluginImage](https://minista.qranoko.jp/docs/plugins/image)
|
|
116
|
-
- [pluginSvg](https://minista.qranoko.jp/docs/plugins/svg): SVG
|
|
117
|
-
- [pluginSprite](https://minista.qranoko.jp/docs/plugins/sprite): SVG
|
|
118
|
-
- [pluginComment](https://minista.qranoko.jp/docs/plugins/comment): HTML
|
|
119
|
-
- [pluginIsland](https://minista.qranoko.jp/docs/plugins/island)
|
|
120
|
-
- [pluginSearch](https://minista.qranoko.jp/docs/plugins/search)
|
|
121
|
-
- [pluginBeautify](https://minista.qranoko.jp/docs/plugins/beautify)
|
|
122
|
-
- [pluginArchive](https://minista.qranoko.jp/docs/plugins/archive)
|
|
115
|
+
- [pluginImage](https://minista.qranoko.jp/docs/plugins/image):画像を最適化・リモート画像をダウンロード
|
|
116
|
+
- [pluginSvg](https://minista.qranoko.jp/docs/plugins/svg): SVGファイルをHTMLにインライン展開
|
|
117
|
+
- [pluginSprite](https://minista.qranoko.jp/docs/plugins/sprite): SVGファイルを スプライト化して出力
|
|
118
|
+
- [pluginComment](https://minista.qranoko.jp/docs/plugins/comment): HTMLにコメントを出力
|
|
119
|
+
- [pluginIsland](https://minista.qranoko.jp/docs/plugins/island):ページの一部をReact App化
|
|
120
|
+
- [pluginSearch](https://minista.qranoko.jp/docs/plugins/search):全文検索機能を追加
|
|
121
|
+
- [pluginBeautify](https://minista.qranoko.jp/docs/plugins/beautify):ビルド時にHTML・CSS・JSを整形
|
|
122
|
+
- [pluginArchive](https://minista.qranoko.jp/docs/plugins/archive):ビルド時に圧縮ファイルを生成
|
|
123
123
|
|
|
124
124
|
## License
|
|
125
125
|
|