create-rspress 2.0.7 → 2.0.9

package/README.md

@@ -15,6 +15,9 @@ npx create-rspress --dir my-project
 
 # Using abbreviations
 npx create-rspress -d my-project
+
+# Scaffold with the custom theme template
+npx create-rspress --dir my-project --template custom-theme
 ```
 
 ## Documentation

package/dist/index.js

@@ -1,9 +1,31 @@
 import node_path from "node:path";
 import { fileURLToPath } from "node:url";
-import { create } from "create-rstack";
+import { checkCancel, create, select as external_create_rstack_select } from "create-rstack";
 const src_dirname = node_path.dirname(fileURLToPath(import.meta.url));
-async function getTemplateName() {
-    return 'basic';
+const templates = [
+    'basic',
+    'custom-theme'
+];
+async function getTemplateName(argv) {
+    if (argv.template) {
+        if (templates.includes(argv.template)) return argv.template;
+        throw new Error(`Invalid template "${argv.template}". Expected one of: ${templates.join(', ')}.`);
+    }
+    return checkCancel(await external_create_rstack_select({
+        message: 'Would you like to customize the theme styles?',
+        initialValue: 'custom-theme',
+        options: [
+            {
+                value: 'custom-theme',
+                label: 'Yes, set up a "theme" folder for customization',
+                hint: 'Modify styles and components later.'
+            },
+            {
+                value: 'basic',
+                label: 'No, use the default theme'
+            }
+        ]
+    }));
 }
 function mapESLintTemplate() {
     return 'vanilla-ts';
@@ -11,8 +33,11 @@ function mapESLintTemplate() {
 create({
     root: node_path.resolve(src_dirname, '..'),
     name: 'rspress',
+    skipFiles: [
+        'template-placeholder'
+    ],
     templates: [
-        'basic'
+        ...templates
     ],
     getTemplateName: getTemplateName,
     mapESLintTemplate: mapESLintTemplate

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rspress",
-  "version": "2.0.7",
+  "version": "2.0.9",
   "description": "Create a new Rspress project",
   "homepage": "https://rspress.rs",
   "repository": {
@@ -23,11 +23,11 @@
     "bin.js"
   ],
   "dependencies": {
-    "create-rstack": "1.8.1"
+    "create-rstack": "1.9.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.57.7",
-    "@rslib/core": "0.20.0",
+    "@rslib/core": "0.21.0",
     "@types/node": "^22.8.1",
     "rsbuild-plugin-publint": "^0.3.4",
     "typescript": "^5.8.2"

package/template-basic/template-placeholder

@@ -0,0 +1 @@
+Keep the template-basic directory in source control.

package/{template-basic → template-common}/docs/guide/start/getting-started.md

@@ -8,6 +8,7 @@ After creating a project with `create-rspress`, you will get the following proje
 - `docs/_nav.json` — The navigation bar configuration.
 - `docs/guide/_meta.json` — The sidebar configuration for the guide section.
 - `docs/public/` — Static assets directory.
+- `theme/` — Optional custom theme directory, generated when you choose the custom theme scaffold.
 - `rspress.config.ts` — The Rspress configuration file.
 
 ## Development

package/{template-basic → template-common}/package.json

@@ -9,7 +9,7 @@
     "preview": "rspress preview"
   },
   "dependencies": {
-    "@rspress/core": "^2.0.6"
+    "@rspress/core": "^2.0.9"
   },
   "devDependencies": {
     "@types/node": "^22.8.1",

package/template-custom-theme/theme/index.css

@@ -0,0 +1,6 @@
+:root {
+  /* Example brand color overrides for the custom theme scaffold. */
+  --rp-c-brand: #0f766e;
+  --rp-c-brand-dark: #115e59;
+  --rp-c-brand-tint: rgba(15, 118, 110, 0.16);
+}

package/template-custom-theme/theme/index.tsx

@@ -0,0 +1,3 @@
+import './index.css';
+
+export * from '@rspress/core/theme-original';