@karaoke-cms/create 0.6.2 → 0.9.0

package/README.md

@@ -0,0 +1,76 @@
+# @karaoke-cms/create
+
+Scaffolding tool for karaoke-cms. Creates a complete new project from scratch with a single command.
+
+## Where it belongs
+
+`packages/create/` in the monorepo. Published to npm as `@karaoke-cms/create` and invoked via npm's `create` shorthand:
+
+```bash
+npm create @karaoke-cms@latest
+# or
+npm create @karaoke-cms@latest my-site
+```
+
+This resolves to running `packages/create/src/index.js` via the `create-karaoke-cms` bin entry.
+
+## What it does
+
+Runs an interactive CLI that prompts for project configuration, then generates a complete project directory:
+
+**Prompts:**
+1. Project directory name
+2. Site title
+3. Site URL (for sitemap and OG tags)
+4. Description
+5. Theme (`default`, `minimal`, or `blog`)
+6. Enable Pagefind search? (y/n)
+7. Enable Giscus comments? (y/n) — if yes, prompts for repo, repoId, category, categoryId
+
+**Generated files:**
+```
+my-site/
+  package.json           # deps pinned to same version as create package
+  astro.config.mjs       # site URL, karaoke() integration
+  karaoke.config.ts      # title, description, theme, modules, vault path
+  src/
+    content.config.ts    # makeCollections() wired to vault/
+    env.d.ts             # /// <reference types="@karaoke-cms/astro/client" />
+  tsconfig.json
+  .gitignore
+  .env.default           # KARAOKE_VAULT=./vault/
+  public/
+    _redirects           # Cloudflare Pages 404 config
+  vault/                 # Obsidian vault with sample blog post and doc
+    blog/
+    docs/
+    karaoke-cms/
+      config/
+        collections.yaml
+        menus.yaml
+```
+
+After scaffolding, `git init` + initial commit runs automatically if `git` is available.
+
+## How to use
+
+```bash
+npm create @karaoke-cms@latest
+
+cd my-site
+npm install
+npm run dev     # → http://localhost:4321
+```
+
+Open `my-site/vault/` in Obsidian to write content. Files with `publish: true` in frontmatter appear on the live site.
+
+Zero runtime dependencies — the scaffolder uses Node.js built-ins only.
+
+## How it changes the behavior of the system
+
+The create package is not imported by running sites — it only runs once at project setup time. Its output determines:
+
+- Which version of `@karaoke-cms/astro` and the theme packages are installed (pinned to the same version as the create package, since packages ship in lockstep)
+- The initial `karaoke.config.ts` shape: which theme, which modules, vault location
+- The initial vault structure: two sample posts so the site is not empty on first `dev`
+- Whether search and comments infrastructure is included in `karaoke.config.ts`

package/karaoke-create-vault/.obsidian/app.json

@@ -0,0 +1,14 @@
+{
+  "attachmentFolderPath": "public/attachments",
+  "alwaysUpdateLinks": true,
+  "showUnsupportedFiles": true,
+  "userIgnoreFilters": [
+    "src",
+    "node_modules",
+    ".github",
+    "scripts",
+    "public",
+    "dist",
+    ".astro"
+  ]
+}

package/karaoke-create-vault/.obsidian/appearance.json

@@ -0,0 +1 @@
+{}

package/karaoke-create-vault/.obsidian/community-plugins.json

@@ -0,0 +1,4 @@
+[
+  "folder-notes",
+  "templater-obsidian"
+]

package/karaoke-create-vault/.obsidian/core-plugins.json

@@ -0,0 +1,33 @@
+{
+  "file-explorer": true,
+  "global-search": true,
+  "switcher": true,
+  "graph": true,
+  "backlink": true,
+  "canvas": true,
+  "outgoing-link": true,
+  "tag-pane": true,
+  "footnotes": false,
+  "properties": true,
+  "page-preview": true,
+  "daily-notes": true,
+  "templates": true,
+  "note-composer": true,
+  "command-palette": true,
+  "slash-command": false,
+  "editor-status": true,
+  "bookmarks": true,
+  "markdown-importer": false,
+  "zk-prefixer": false,
+  "random-note": false,
+  "outline": true,
+  "word-count": true,
+  "slides": false,
+  "audio-recorder": false,
+  "workspaces": false,
+  "file-recovery": true,
+  "publish": false,
+  "sync": true,
+  "bases": true,
+  "webviewer": false
+}

package/karaoke-create-vault/.obsidian/plugins/folder-notes/data.json

@@ -0,0 +1,131 @@
+{
+  "syncFolderName": true,
+  "ctrlKey": true,
+  "altKey": false,
+  "hideFolderNote": true,
+  "templatePath": "",
+  "autoCreate": false,
+  "autoCreateFocusFiles": true,
+  "autoCreateForAttachmentFolder": false,
+  "autoCreateForFiles": false,
+  "enableCollapsing": false,
+  "excludeFolders": [],
+  "whitelistFolders": [],
+  "showDeleteConfirmation": true,
+  "underlineFolder": true,
+  "stopWhitespaceCollapsing": true,
+  "underlineFolderInPath": true,
+  "openFolderNoteOnClickInPath": true,
+  "openInNewTab": false,
+  "focusExistingTab": false,
+  "oldFolderNoteName": "{{folder_name}}",
+  "folderNoteName": "index",
+  "folderNoteType": ".md",
+  "disableFolderHighlighting": false,
+  "newFolderNoteName": "{{folder_name}}",
+  "storageLocation": "insideFolder",
+  "syncDelete": false,
+  "showRenameConfirmation": true,
+  "defaultOverview": {
+    "id": "",
+    "folderPath": "",
+    "title": "{{folderName}} overview",
+    "showTitle": false,
+    "depth": 3,
+    "includeTypes": [
+      "folder",
+      "markdown"
+    ],
+    "style": "list",
+    "disableFileTag": false,
+    "sortBy": "name",
+    "sortByAsc": true,
+    "showEmptyFolders": true,
+    "onlyIncludeSubfolders": true,
+    "storeFolderCondition": true,
+    "showFolderNotes": false,
+    "disableCollapseIcon": true,
+    "alwaysCollapse": false,
+    "autoSync": true,
+    "allowDragAndDrop": true,
+    "hideLinkList": true,
+    "hideFolderOverview": false,
+    "useActualLinks": false,
+    "fmtpIntegration": false,
+    "titleSize": 1,
+    "isInCallout": false,
+    "useWikilinks": true
+  },
+  "useSubmenus": true,
+  "syncMove": true,
+  "frontMatterTitle": {
+    "enabled": false,
+    "explorer": true,
+    "path": true
+  },
+  "settingsTab": "general",
+  "supportedFileTypes": [
+    "md",
+    "canvas",
+    "base"
+  ],
+  "boldName": false,
+  "boldNameInPath": false,
+  "cursiveName": false,
+  "cursiveNameInPath": false,
+  "disableOpenFolderNoteOnClick": false,
+  "openByClick": true,
+  "openWithCtrl": false,
+  "openWithAlt": false,
+  "excludeFolderDefaultSettings": {
+    "type": "folder",
+    "path": "",
+    "id": "c102b934-b388-4ae6-9712-a566cc85d23a",
+    "subFolders": true,
+    "disableSync": true,
+    "disableAutoCreate": true,
+    "disableFolderNote": false,
+    "enableCollapsing": false,
+    "position": 0,
+    "excludeFromFolderOverview": false,
+    "string": "",
+    "hideInSettings": false,
+    "detached": false,
+    "showFolderNote": false
+  },
+  "excludePatternDefaultSettings": {
+    "type": "pattern",
+    "path": "",
+    "id": "a87f72a1-2508-48f8-b251-344b5bdb5729",
+    "subFolders": true,
+    "disableSync": true,
+    "disableAutoCreate": true,
+    "disableFolderNote": false,
+    "enableCollapsing": false,
+    "position": 0,
+    "excludeFromFolderOverview": false,
+    "string": "",
+    "hideInSettings": false,
+    "detached": false,
+    "showFolderNote": false
+  },
+  "hideCollapsingIcon": false,
+  "hideCollapsingIconForEmptyFolders": false,
+  "tabManagerEnabled": true,
+  "ignoreAttachmentFolder": true,
+  "deleteFilesAction": "trash",
+  "openSidebar": {
+    "mobile": false,
+    "desktop": true
+  },
+  "highlightFolder": true,
+  "persistentSettingsTab": {
+    "afterRestart": true,
+    "afterChangingTab": true
+  },
+  "firstTimeInsertOverview": true,
+  "fvGlobalSettings": {
+    "autoUpdateLinks": true
+  },
+  "hideFolderNoteNameInPath": false
+}