create-riebeckite 0.0.4 → 0.0.5

package/README.md

@@ -1,6 +1,6 @@
 # create-riebeckite
 
-Create a new Riebeckite site from the official starter template.
+Create a new Riebeckite site from an official starter preset.
 
 ## Usage
 
@@ -11,9 +11,67 @@ npm install
 npx riebeckite build
 ```
 
-Pass `--force` to scaffold into a non-empty directory.
+## Options
+
+| Option | Description |
+| --- | --- |
+| `[directory]` | Directory to scaffold into (default: the current directory) |
+| `--preset <name>` | Starter composition, e.g. `rich` (default: `starter`) |
+| `--force` | Scaffold even when the target directory is not empty |
+| `--list-presets` | Print the available presets and their descriptions, then exit |
+
+For example, scaffold with the `rich` preset:
+
+```sh
+npx create-riebeckite my-site --preset rich
+```
+
+## Presets
+
+List the available presets with `--list-presets`:
+
+```sh
+npx create-riebeckite --list-presets
+```
+
+Every preset is a self-contained starter description. From smallest to
+largest:
+
+| Preset  | Theme        | Plugins | Content pages                                        |
+| ------- | ------------ | ------- | ---------------------------------------------------- |
+| `empty` | none         | none    | none (static index)                                  |
+| `minimal` | minimal    | 1       | index                                                |
+| `starter` | default    | 3       | index (7 languages)                                  |
+| `rich`  | default      | 8       | index, framework/plugins, framework/themes (7 languages) |
+| `full`  | default      | 23      | rich + guide                                          |
+| `max`   | default      | 46      | full + examples                                       |
+| `ultra` | default      | 52      | max + reference/plugins, reference/themes             |
+
+Each preset has a one-line description, shown by `--list-presets`:
+
+- `empty` — A blank application shell: no plugins, theme, content, or components.
+- `minimal` — The smallest useful site: Obsidian Markdown, the minimal theme, one page.
+- `starter` — The default starter: Obsidian Markdown, color mode, seven languages, and a site header.
+- `rich` — Publishing and reading plugins plus guided ecosystem tour pages in seven languages.
+- `full` — A ready blog: discovery, media, and reading plugins plus a build guide.
+- `max` — Diagram and knowledge plugins on top of `full`, with showcase example pages.
+- `ultra` — The full plugin catalog and theme reference pages — everything the ecosystem offers.
+
+Presets are defined in `@riebeckite/honox` and can be imported into your own
+tooling:
+
+```ts
+import { scaffoldRiebeckiteSite, rich } from "@riebeckite/honox";
+
+await scaffoldRiebeckiteSite({
+  targetDirectory: "./my-site",
+  preset: rich,
+});
+```
+
+## Further reading
 
 Riebeckite is an extensible framework for publishing Markdown and
 Obsidian-oriented notes on the web. See the
 [Riebeckite documentation](https://github.com/Rerurate514/riebeckite#readme)
-for configuration and plugin guidance.
+for configuration and plugin guidance.

package/README_ja.md

@@ -0,0 +1,65 @@
+# create-riebeckite
+
+公式スターターテンプレートから、新しい Riebeckite サイトを作成するための
+CLI ツールです。
+
+[English](./README.md)
+
+## 使い方
+
+```sh
+npx create-riebeckite my-site
+cd my-site
+npm install
+npx riebeckite build
+```
+
+## オプション
+
+| オプション | 説明 |
+| --- | --- |
+| `[directory]` | 生成先ディレクトリ（既定はカレントディレクトリ） |
+| `--preset <name>` | 使用するスターター構成（既定は `starter`） |
+| `--force` | 空でないディレクトリにも展開する |
+| `--list-presets` | 利用可能な preset と説明を一覧表示して終了する |
+
+たとえば、`rich` preset で生成する場合は次のようにします。
+
+```sh
+npx create-riebeckite my-site --preset rich
+```
+
+## Preset
+
+利用可能な preset は `--list-presets` で確認できます。
+
+```sh
+npx create-riebeckite --list-presets
+```
+
+すべての preset は自己完結のスターターで、小さいものから順に次のとおりです。
+
+| Preset | Theme | Plugins | コンテンツページ |
+| --- | --- | --- | --- |
+| `empty` | なし | なし | なし（静的インデックスのみ） |
+| `minimal` | minimal | 1 | index |
+| `starter` | default | 3 | index（7 言語） |
+| `rich` | default | 8 | index、framework/plugins、framework/themes（7 言語） |
+| `full` | default | 23 | rich + guide |
+| `max` | default | 46 | full + examples |
+| `ultra` | default | 52 | max + reference/plugins、reference/themes |
+
+各 preset の説明は次のとおりです（`--list-presets` で表示される内容と同じです）。
+
+- `empty` — 空のアプリケーションシェル（Plugin・Theme・コンテンツ・コンポーネントなし）
+- `minimal` — 最小構成のサイト（Obsidian Markdown、minimal Theme、1 ページ）
+- `starter` — 標準のスターター（Obsidian Markdown、カラーモード、7 言語、サイトヘッダー）
+- `rich` — 公開・閲覧向け Plugin と、エコシステムを紹介するページ（7 言語）
+- `full` — ブログ一式（検索・メディア・関連記事などの Plugin とビルドガイド）
+- `max` — `full` に図表・ナレッジ系 Plugin とサンプルページを追加
+- `ultra` — 全 Plugin カタログと Theme リファレンスページ（エコシステムの一式）
+
+Riebeckite は、Markdown や Obsidian 由来のノートを Web で公開するための
+拡張可能なフレームワークです。設定方法やプラグインについては
+[Riebeckite ドキュメント](https://github.com/Rerurate514/riebeckite#readme)
+を参照してください。

package/dist/src/index.d.ts

@@ -1,5 +1,8 @@
+import { type ScaffoldPresetName } from "@riebeckite/honox";
 export type CreateRiebeckiteOptions = {
     readonly directory: string;
     readonly force: boolean;
+    readonly preset: ScaffoldPresetName;
+    readonly listPresets: boolean;
 };
 export declare function runCreateRiebeckite(arguments_: readonly string[]): Promise<void>;

package/dist/src/index.js

@@ -1,6 +1,12 @@
 // src/index.ts
 import path from "node:path";
-import { ScaffoldSiteError, scaffoldRiebeckiteSite } from "@riebeckite/honox";
+import {
+  isScaffoldPresetName,
+  SCAFFOLD_PRESET_NAMES,
+  ScaffoldSiteError,
+  scaffoldPresets,
+  scaffoldRiebeckiteSite
+} from "@riebeckite/honox";
 async function runCreateRiebeckite(arguments_) {
   let options;
   try {
@@ -10,14 +16,19 @@ async function runCreateRiebeckite(arguments_) {
     process.exitCode = 1;
     return;
   }
+  if (options.listPresets) {
+    printPresets();
+    return;
+  }
   const targetDirectory = path.resolve(process.cwd(), options.directory);
   try {
     const result = await scaffoldRiebeckiteSite({
       targetDirectory,
-      overwrite: options.force
+      overwrite: options.force,
+      preset: options.preset
     });
     const relative = path.relative(process.cwd(), result.targetDirectory) || ".";
-    console.log(`Created a Riebeckite site in ${relative}`);
+    console.log(`Created a ${options.preset} Riebeckite site in ${relative}`);
     console.log("");
     console.log("Next steps:");
     if (relative !== ".") console.log(`  cd ${relative}`);
@@ -36,20 +47,52 @@ async function runCreateRiebeckite(arguments_) {
 function parseArguments(arguments_) {
   let directory;
   let force = false;
-  for (const argument of arguments_) {
+  let preset;
+  let listPresets = false;
+  for (let index = 0; index < arguments_.length; index += 1) {
+    const argument = arguments_[index];
     if (argument === "--force") {
       force = true;
       continue;
     }
+    if (argument === "--list-presets") {
+      listPresets = true;
+      continue;
+    }
+    if (argument === "--preset") {
+      const value = arguments_[index + 1];
+      if (value === void 0 || !isScaffoldPresetName(value)) {
+        throw new Error(
+          `Unknown preset: ${value ?? "(missing)"}. Available presets: ${SCAFFOLD_PRESET_NAMES.join(", ")}.`
+        );
+      }
+      preset = value;
+      index += 1;
+      continue;
+    }
     if (argument.startsWith("-")) {
       throw new Error(`Unknown option: ${argument}`);
     }
     if (directory !== void 0) {
-      throw new Error("Usage: create-riebeckite [directory] [--force]");
+      throw new Error(
+        "Usage: create-riebeckite [directory] [--preset <name>] [--force]"
+      );
     }
     directory = argument;
   }
-  return { directory: directory ?? ".", force };
+  return {
+    directory: directory ?? ".",
+    force,
+    preset: preset ?? "starter",
+    listPresets
+  };
+}
+function printPresets() {
+  console.log("Available presets:");
+  console.log("");
+  for (const name of SCAFFOLD_PRESET_NAMES) {
+    console.log(`  ${name}: ${scaffoldPresets[name].description}`);
+  }
 }
 export {
   runCreateRiebeckite

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-riebeckite",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/src/index.js",
@@ -19,6 +19,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "README_ja.md",
     "bin",
     "dist"
   ],
@@ -26,7 +27,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@riebeckite/honox": "0.0.4"
+    "@riebeckite/honox": "0.0.5"
   },
   "repository": {
     "type": "git",