@karaoke-cms/create 0.9.2 → 0.9.3

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.
@@ -27,12 +27,12 @@
27
27
  "state": {
28
28
  "type": "markdown",
29
29
  "state": {
30
- "file": "karaoke-cms/manual/configuration.md",
30
+ "file": "karaoke-cms/manual/deployment.md",
31
31
  "mode": "source",
32
32
  "source": false
33
33
  },
34
34
  "icon": "lucide-file",
35
- "title": "configuration"
35
+ "title": "deployment"
36
36
  }
37
37
  }
38
38
  ],
@@ -183,10 +183,10 @@
183
183
  "state": {
184
184
  "type": "file-properties",
185
185
  "state": {
186
- "file": "karaoke-cms/manual/configuration.md"
186
+ "file": "karaoke-cms/manual/deployment.md"
187
187
  },
188
188
  "icon": "lucide-info",
189
- "title": "File properties for configuration"
189
+ "title": "File properties for deployment"
190
190
  }
191
191
  }
192
192
  ],
@@ -210,13 +210,13 @@
210
210
  },
211
211
  "active": "52e565c48d7a7c39",
212
212
  "lastOpenFiles": [
213
+ "karaoke-cms/manual/configuration.md",
213
214
  "karaoke-cms/templates/index.md",
214
215
  "karaoke-cms/config/index.md",
215
216
  "karaoke-cms/templates/docs-header.md",
216
217
  "karaoke-cms/templates/blog-header.md",
217
218
  "karaoke-cms/templates/index-by-foldernote.md",
218
219
  "karaoke-cms/manual/content.md",
219
- "karaoke-cms/manual/configuration.md",
220
220
  "blog/hello-world.md",
221
221
  "karaoke-cms/templates",
222
222
  "karaoke-cms/index.md",
@@ -5,6 +5,37 @@ date: 2026-01-01
5
5
  description: "How to set up and use your karaoke-cms site."
6
6
  ---
7
7
 
8
+ ## System setup
9
+
10
+ **Prerequisites:** Node.js 20+, npm, Obsidian.
11
+
12
+ Create a new project:
13
+
14
+ ```bash
15
+ npm create @karaoke-cms@latest my-site
16
+ cd my-site
17
+ ```
18
+
19
+ Open the project folder in Obsidian as a vault. Configure `karaoke.config.ts`:
20
+
21
+ ```ts
22
+ export default {
23
+ title: "My Site",
24
+ description: "What this site is about.",
25
+ vault: "./karaoke-template-vault/",
26
+ theme: "@karaoke-cms/theme-default",
27
+ };
28
+ ```
29
+
30
+ Add two secrets to your GitHub repository for deployment:
31
+
32
+ | Secret | Where to get it |
33
+ |--------|-----------------|
34
+ | `CLOUDFLARE_API_TOKEN` | Cloudflare dashboard → API Tokens |
35
+ | `CLOUDFLARE_ACCOUNT_ID` | Cloudflare dashboard → Account overview |
36
+
37
+ Push to `main` — GitHub Actions builds and deploys to Cloudflare Pages automatically.
38
+
8
39
  ## Open in Obsidian
9
40
 
10
41
  Your project root is an Obsidian vault. Open this folder in Obsidian to write content with full wikilink navigation, templates, and graph view.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@karaoke-cms/create",
3
3
  "type": "module",
4
- "version": "0.9.2",
4
+ "version": "0.9.3",
5
5
  "description": "Scaffold a new karaoke-cms project",
6
6
  "bin": {
7
7
  "create-karaoke-cms": "./src/index.js"
@@ -20,10 +20,10 @@
20
20
  "scaffold",
21
21
  "obsidian"
22
22
  ],
23
- "devDependencies": {
24
- "vitest": "^4.1.1"
25
- },
26
23
  "scripts": {
27
24
  "test": "vitest run test/templates.test.js test/index.test.js"
25
+ },
26
+ "devDependencies": {
27
+ "vitest": "^4.1.1"
28
28
  }
29
- }
29
+ }
package/src/index.js CHANGED
@@ -110,9 +110,7 @@ async function main() {
110
110
  const title = await ask('Site title', defaultTitle);
111
111
  const description = await ask('Description', 'Our team knowledge base.');
112
112
  const themeChoice = await askChoice('Theme', ['default', 'minimal', 'blog'], 0);
113
- const theme = themeChoice === 'default' || themeChoice === 'minimal'
114
- ? themeChoice
115
- : `@karaoke-cms/theme-${themeChoice}`;
113
+ const theme = `@karaoke-cms/theme-${themeChoice}`;
116
114
  const search = await askYesNo('Enable search? (Pagefind)', true);
117
115
  const commentsEnabled = await askYesNo('Enable comments? (requires Giscus setup)', false);
118
116
 
package/src/templates.js CHANGED
@@ -43,7 +43,7 @@ export function packageJson({ name, astroVersion, theme }) {
43
43
  },
44
44
  dependencies,
45
45
  devDependencies: {
46
- wrangler: '^3',
46
+ wrangler: '^4',
47
47
  },
48
48
  }, null, 2) + '\n';
49
49
  }