create-riebeckite 0.0.7 → 0.0.11
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 +78 -78
- package/README_ja.md +64 -64
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,79 +1,79 @@
|
|
|
1
|
-
# create-riebeckite
|
|
2
|
-
|
|
3
|
-
Create a new Riebeckite site from an official starter preset.
|
|
4
|
-
|
|
5
|
-
[日本語](./README_ja.md)
|
|
6
|
-
|
|
7
|
-
## Usage
|
|
8
|
-
|
|
9
|
-
```sh
|
|
10
|
-
npx create-riebeckite my-site
|
|
11
|
-
cd my-site
|
|
12
|
-
npm install
|
|
13
|
-
npm
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Option | Description |
|
|
19
|
-
| --- | --- |
|
|
20
|
-
| `[directory]` | Directory to scaffold into (default: the current directory) |
|
|
21
|
-
| `--preset <name>` | Starter composition, e.g. `rich` (default: `starter`) |
|
|
22
|
-
| `--force` | Scaffold even when the target directory is not empty |
|
|
23
|
-
| `--list-presets` | Print the available presets and their descriptions, then exit |
|
|
24
|
-
|
|
25
|
-
For example, scaffold with the `rich` preset:
|
|
26
|
-
|
|
27
|
-
```sh
|
|
28
|
-
npx create-riebeckite my-site --preset rich
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
## Presets
|
|
32
|
-
|
|
33
|
-
List the available presets with `--list-presets`:
|
|
34
|
-
|
|
35
|
-
```sh
|
|
36
|
-
npx create-riebeckite --list-presets
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
Every preset is a self-contained starter description. From smallest to
|
|
40
|
-
largest:
|
|
41
|
-
|
|
42
|
-
| Preset | Theme | Plugins | Content pages |
|
|
43
|
-
| ------- | ------------ | ------- | ---------------------------------------------------- |
|
|
44
|
-
| `empty` | none | none | none (static index) |
|
|
45
|
-
| `minimal` | minimal | 1 | index |
|
|
46
|
-
| `starter` | default | 3 | index (7 languages) |
|
|
47
|
-
| `rich` | default | 8 | index, framework/plugins, framework/themes (7 languages) |
|
|
48
|
-
| `full` | default | 23 | rich + guide |
|
|
49
|
-
| `max` | default | 46 | full + examples |
|
|
50
|
-
| `ultra` | default | 52 | max + reference/plugins, reference/themes |
|
|
51
|
-
|
|
52
|
-
Each preset has a one-line description, shown by `--list-presets`:
|
|
53
|
-
|
|
54
|
-
- `empty` — A blank application shell: no plugins, theme, content, or components.
|
|
55
|
-
- `minimal` — The smallest useful site: Obsidian Markdown, the minimal theme, one page.
|
|
56
|
-
- `starter` — The default starter: Obsidian Markdown, color mode, seven languages, and a site header.
|
|
57
|
-
- `rich` — Publishing and reading plugins plus guided ecosystem tour pages in seven languages.
|
|
58
|
-
- `full` — A ready blog: discovery, media, and reading plugins plus a build guide.
|
|
59
|
-
- `max` — Diagram and knowledge plugins on top of `full`, with showcase example pages.
|
|
60
|
-
- `ultra` — The full plugin catalog and theme reference pages — everything the ecosystem offers.
|
|
61
|
-
|
|
62
|
-
Presets are defined in `@riebeckite/honox` and can be imported into your own
|
|
63
|
-
tooling:
|
|
64
|
-
|
|
65
|
-
```ts
|
|
66
|
-
import { scaffoldRiebeckiteSite, rich } from "@riebeckite/honox";
|
|
67
|
-
|
|
68
|
-
await scaffoldRiebeckiteSite({
|
|
69
|
-
targetDirectory: "./my-site",
|
|
70
|
-
preset: rich,
|
|
71
|
-
});
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
## Further reading
|
|
75
|
-
|
|
76
|
-
Riebeckite is an extensible framework for publishing Markdown and
|
|
77
|
-
Obsidian-oriented notes on the web. See the
|
|
78
|
-
[Riebeckite documentation](https://github.com/Rerurate514/riebeckite#readme)
|
|
1
|
+
# create-riebeckite
|
|
2
|
+
|
|
3
|
+
Create a new Riebeckite site from an official starter preset.
|
|
4
|
+
|
|
5
|
+
[日本語](./README_ja.md)
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npx create-riebeckite my-site
|
|
11
|
+
cd my-site
|
|
12
|
+
npm install
|
|
13
|
+
npm exec riebeckite build
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Options
|
|
17
|
+
|
|
18
|
+
| Option | Description |
|
|
19
|
+
| --- | --- |
|
|
20
|
+
| `[directory]` | Directory to scaffold into (default: the current directory) |
|
|
21
|
+
| `--preset <name>` | Starter composition, e.g. `rich` (default: `starter`) |
|
|
22
|
+
| `--force` | Scaffold even when the target directory is not empty |
|
|
23
|
+
| `--list-presets` | Print the available presets and their descriptions, then exit |
|
|
24
|
+
|
|
25
|
+
For example, scaffold with the `rich` preset:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
npx create-riebeckite my-site --preset rich
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Presets
|
|
32
|
+
|
|
33
|
+
List the available presets with `--list-presets`:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
npx create-riebeckite --list-presets
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Every preset is a self-contained starter description. From smallest to
|
|
40
|
+
largest:
|
|
41
|
+
|
|
42
|
+
| Preset | Theme | Plugins | Content pages |
|
|
43
|
+
| ------- | ------------ | ------- | ---------------------------------------------------- |
|
|
44
|
+
| `empty` | none | none | none (static index) |
|
|
45
|
+
| `minimal` | minimal | 1 | index |
|
|
46
|
+
| `starter` | default | 3 | index (7 languages) |
|
|
47
|
+
| `rich` | default | 8 | index, framework/plugins, framework/themes (7 languages) |
|
|
48
|
+
| `full` | default | 23 | rich + guide |
|
|
49
|
+
| `max` | default | 46 | full + examples |
|
|
50
|
+
| `ultra` | default | 52 | max + reference/plugins, reference/themes |
|
|
51
|
+
|
|
52
|
+
Each preset has a one-line description, shown by `--list-presets`:
|
|
53
|
+
|
|
54
|
+
- `empty` — A blank application shell: no plugins, theme, content, or components.
|
|
55
|
+
- `minimal` — The smallest useful site: Obsidian Markdown, the minimal theme, one page.
|
|
56
|
+
- `starter` — The default starter: Obsidian Markdown, color mode, seven languages, and a site header.
|
|
57
|
+
- `rich` — Publishing and reading plugins plus guided ecosystem tour pages in seven languages.
|
|
58
|
+
- `full` — A ready blog: discovery, media, and reading plugins plus a build guide.
|
|
59
|
+
- `max` — Diagram and knowledge plugins on top of `full`, with showcase example pages.
|
|
60
|
+
- `ultra` — The full plugin catalog and theme reference pages — everything the ecosystem offers.
|
|
61
|
+
|
|
62
|
+
Presets are defined in `@riebeckite/honox` and can be imported into your own
|
|
63
|
+
tooling:
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
import { scaffoldRiebeckiteSite, rich } from "@riebeckite/honox";
|
|
67
|
+
|
|
68
|
+
await scaffoldRiebeckiteSite({
|
|
69
|
+
targetDirectory: "./my-site",
|
|
70
|
+
preset: rich,
|
|
71
|
+
});
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Further reading
|
|
75
|
+
|
|
76
|
+
Riebeckite is an extensible framework for publishing Markdown and
|
|
77
|
+
Obsidian-oriented notes on the web. See the
|
|
78
|
+
[Riebeckite documentation](https://github.com/Rerurate514/riebeckite#readme)
|
|
79
79
|
for configuration and plugin guidance.
|
package/README_ja.md
CHANGED
|
@@ -1,65 +1,65 @@
|
|
|
1
|
-
# create-riebeckite
|
|
2
|
-
|
|
3
|
-
公式スターターテンプレートから、新しい Riebeckite サイトを作成するための
|
|
4
|
-
CLI ツールです。
|
|
5
|
-
|
|
6
|
-
[English](./README.md)
|
|
7
|
-
|
|
8
|
-
## 使い方
|
|
9
|
-
|
|
10
|
-
```sh
|
|
11
|
-
npx create-riebeckite my-site
|
|
12
|
-
cd my-site
|
|
13
|
-
npm install
|
|
14
|
-
npm
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## オプション
|
|
18
|
-
|
|
19
|
-
| オプション | 説明 |
|
|
20
|
-
| --- | --- |
|
|
21
|
-
| `[directory]` | 生成先ディレクトリ（既定はカレントディレクトリ） |
|
|
22
|
-
| `--preset <name>` | 使用するスターター構成（既定は `starter`） |
|
|
23
|
-
| `--force` | 空でないディレクトリにも展開する |
|
|
24
|
-
| `--list-presets` | 利用可能な preset と説明を一覧表示して終了する |
|
|
25
|
-
|
|
26
|
-
たとえば、`rich` preset で生成する場合は次のようにします。
|
|
27
|
-
|
|
28
|
-
```sh
|
|
29
|
-
npx create-riebeckite my-site --preset rich
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Preset
|
|
33
|
-
|
|
34
|
-
利用可能な preset は `--list-presets` で確認できます。
|
|
35
|
-
|
|
36
|
-
```sh
|
|
37
|
-
npx create-riebeckite --list-presets
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
すべての preset は自己完結のスターターで、小さいものから順に次のとおりです。
|
|
41
|
-
|
|
42
|
-
| Preset | Theme | Plugins | コンテンツページ |
|
|
43
|
-
| --- | --- | --- | --- |
|
|
44
|
-
| `empty` | なし | なし | なし（静的インデックスのみ） |
|
|
45
|
-
| `minimal` | minimal | 1 | index |
|
|
46
|
-
| `starter` | default | 3 | index（7 言語） |
|
|
47
|
-
| `rich` | default | 8 | index、framework/plugins、framework/themes（7 言語） |
|
|
48
|
-
| `full` | default | 23 | rich + guide |
|
|
49
|
-
| `max` | default | 46 | full + examples |
|
|
50
|
-
| `ultra` | default | 52 | max + reference/plugins、reference/themes |
|
|
51
|
-
|
|
52
|
-
各 preset の説明は次のとおりです（`--list-presets` で表示される内容と同じです）。
|
|
53
|
-
|
|
54
|
-
- `empty` — 空のアプリケーションシェル（Plugin・Theme・コンテンツ・コンポーネントなし）
|
|
55
|
-
- `minimal` — 最小構成のサイト（Obsidian Markdown、minimal Theme、1 ページ）
|
|
56
|
-
- `starter` — 標準のスターター（Obsidian Markdown、カラーモード、7 言語、サイトヘッダー）
|
|
57
|
-
- `rich` — 公開・閲覧向け Plugin と、エコシステムを紹介するページ（7 言語）
|
|
58
|
-
- `full` — ブログ一式（検索・メディア・関連記事などの Plugin とビルドガイド）
|
|
59
|
-
- `max` — `full` に図表・ナレッジ系 Plugin とサンプルページを追加
|
|
60
|
-
- `ultra` — 全 Plugin カタログと Theme リファレンスページ（エコシステムの一式）
|
|
61
|
-
|
|
62
|
-
Riebeckite は、Markdown や Obsidian 由来のノートを Web で公開するための
|
|
63
|
-
拡張可能なフレームワークです。設定方法やプラグインについては
|
|
64
|
-
[Riebeckite ドキュメント](https://github.com/Rerurate514/riebeckite#readme)
|
|
1
|
+
# create-riebeckite
|
|
2
|
+
|
|
3
|
+
公式スターターテンプレートから、新しい Riebeckite サイトを作成するための
|
|
4
|
+
CLI ツールです。
|
|
5
|
+
|
|
6
|
+
[English](./README.md)
|
|
7
|
+
|
|
8
|
+
## 使い方
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
npx create-riebeckite my-site
|
|
12
|
+
cd my-site
|
|
13
|
+
npm install
|
|
14
|
+
npm exec riebeckite build
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## オプション
|
|
18
|
+
|
|
19
|
+
| オプション | 説明 |
|
|
20
|
+
| --- | --- |
|
|
21
|
+
| `[directory]` | 生成先ディレクトリ（既定はカレントディレクトリ） |
|
|
22
|
+
| `--preset <name>` | 使用するスターター構成（既定は `starter`） |
|
|
23
|
+
| `--force` | 空でないディレクトリにも展開する |
|
|
24
|
+
| `--list-presets` | 利用可能な preset と説明を一覧表示して終了する |
|
|
25
|
+
|
|
26
|
+
たとえば、`rich` preset で生成する場合は次のようにします。
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
npx create-riebeckite my-site --preset rich
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Preset
|
|
33
|
+
|
|
34
|
+
利用可能な preset は `--list-presets` で確認できます。
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
npx create-riebeckite --list-presets
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
すべての preset は自己完結のスターターで、小さいものから順に次のとおりです。
|
|
41
|
+
|
|
42
|
+
| Preset | Theme | Plugins | コンテンツページ |
|
|
43
|
+
| --- | --- | --- | --- |
|
|
44
|
+
| `empty` | なし | なし | なし（静的インデックスのみ） |
|
|
45
|
+
| `minimal` | minimal | 1 | index |
|
|
46
|
+
| `starter` | default | 3 | index（7 言語） |
|
|
47
|
+
| `rich` | default | 8 | index、framework/plugins、framework/themes（7 言語） |
|
|
48
|
+
| `full` | default | 23 | rich + guide |
|
|
49
|
+
| `max` | default | 46 | full + examples |
|
|
50
|
+
| `ultra` | default | 52 | max + reference/plugins、reference/themes |
|
|
51
|
+
|
|
52
|
+
各 preset の説明は次のとおりです（`--list-presets` で表示される内容と同じです）。
|
|
53
|
+
|
|
54
|
+
- `empty` — 空のアプリケーションシェル（Plugin・Theme・コンテンツ・コンポーネントなし）
|
|
55
|
+
- `minimal` — 最小構成のサイト（Obsidian Markdown、minimal Theme、1 ページ）
|
|
56
|
+
- `starter` — 標準のスターター（Obsidian Markdown、カラーモード、7 言語、サイトヘッダー）
|
|
57
|
+
- `rich` — 公開・閲覧向け Plugin と、エコシステムを紹介するページ（7 言語）
|
|
58
|
+
- `full` — ブログ一式（検索・メディア・関連記事などの Plugin とビルドガイド）
|
|
59
|
+
- `max` — `full` に図表・ナレッジ系 Plugin とサンプルページを追加
|
|
60
|
+
- `ultra` — 全 Plugin カタログと Theme リファレンスページ（エコシステムの一式）
|
|
61
|
+
|
|
62
|
+
Riebeckite は、Markdown や Obsidian 由来のノートを Web で公開するための
|
|
63
|
+
拡張可能なフレームワークです。設定方法やプラグインについては
|
|
64
|
+
[Riebeckite ドキュメント](https://github.com/Rerurate514/riebeckite#readme)
|
|
65
65
|
を参照してください。
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-riebeckite",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.11",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/src/index.js",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"access": "public"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@riebeckite/honox": "0.0.
|
|
30
|
+
"@riebeckite/honox": "0.0.11"
|
|
31
31
|
},
|
|
32
32
|
"repository": {
|
|
33
33
|
"type": "git",
|