@karaoke-cms/create 0.6.2 → 0.6.3

package/karaoke-create-vault/.obsidian/plugins/templater-obsidian/manifest.json

@@ -0,0 +1,11 @@
+{
+    "id": "templater-obsidian",
+    "name": "Templater",
+    "version": "2.18.1",
+    "description": "Create and use templates",
+    "minAppVersion": "1.5.0",
+    "author": "SilentVoid",
+    "authorUrl": "https://github.com/SilentVoid13",
+    "helpUrl": "https://silentvoid13.github.io/Templater/",
+    "isDesktopOnly": false
+}

package/karaoke-create-vault/.obsidian/plugins/templater-obsidian/styles.css

@@ -0,0 +1,226 @@
+.templater_search {
+    width: calc(100% - 20px);
+}
+
+.templater_div {
+    border-top: 1px solid var(--background-modifier-border);
+}
+
+.templater_div > .setting-item {
+    border-top: none !important;
+    align-self: center;
+}
+
+.templater_div > .setting-item > .setting-item-control {
+    justify-content: space-around;
+    padding: 0;
+    width: 100%;
+}
+
+.templater_div
+    > .setting-item
+    > .setting-item-control
+    > .setting-editor-extra-setting-button {
+    align-self: center;
+}
+
+.templater_donating {
+    margin: 10px;
+}
+
+.templater_title {
+    margin: 0;
+    padding: 0;
+    margin-top: 5px;
+    text-align: center;
+}
+
+.templater_template {
+    align-self: center;
+    margin-left: 5px;
+    margin-right: 5px;
+    width: 70%;
+}
+
+.templater_cmd {
+    margin-left: 5px;
+    margin-right: 5px;
+    font-size: 14px;
+    width: 100%;
+}
+
+.templater_div2 > .setting-item {
+    align-content: center;
+    justify-content: center;
+}
+
+.templater-prompt-div,
+.templater-multisuggester-div {
+    display: flex;
+}
+
+.templater-prompt-form {
+    display: flex;
+    flex-grow: 1;
+}
+
+.templater-prompt-input,
+.templater-multisuggester-input {
+    flex-grow: 1;
+}
+
+.templater-button-div {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    margin-top: 1rem;
+}
+
+textarea.templater-prompt-input {
+    height: 10rem;
+}
+
+textarea.templater-prompt-input:focus {
+    border-color: var(--interactive-accent);
+}
+
+.templater-multisuggester-list {
+    margin: 1.5em 0;
+}
+
+.cm-s-obsidian .templater-command-bg {
+    left: 0px;
+    right: 0px;
+    background-color: var(--background-primary-alt);
+}
+
+.cm-s-obsidian .cm-templater-command {
+    font-size: 0.85em;
+    font-family: var(--font-monospace);
+    line-height: 1.3;
+}
+
+.cm-s-obsidian .templater-inline .cm-templater-command {
+    background-color: var(--background-primary-alt);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-templater-opening-tag {
+    font-weight: bold;
+}
+
+.cm-s-obsidian .cm-templater-command.cm-templater-closing-tag {
+    font-weight: bold;
+}
+
+.cm-s-obsidian .cm-templater-command.cm-templater-interpolation-tag {
+    color: var(--code-property, #008bff);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-templater-execution-tag {
+    color: var(--code-function, #c0d700);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-keyword {
+    color: var(--code-keyword, #00a7aa);
+    font-weight: normal;
+}
+
+.cm-s-obsidian .cm-templater-command.cm-atom {
+    color: var(--code-normal, #f39b35);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-value,
+.cm-s-obsidian .cm-templater-command.cm-number,
+.cm-s-obsidian .cm-templater-command.cm-type {
+    color: var(--code-value, #a06fca);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-def,
+.cm-s-obsidian .cm-templater-command.cm-type.cm-def {
+    color: var(--code-normal, var(--text-normal));
+}
+
+.cm-s-obsidian .cm-templater-command.cm-property,
+.cm-s-obsidian .cm-templater-command.cm-property.cm-def,
+.cm-s-obsidian .cm-templater-command.cm-attribute {
+    color: var(--code-function, #98e342);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-variable,
+.cm-s-obsidian .cm-templater-command.cm-variable-2,
+.cm-s-obsidian .cm-templater-command.cm-variable-3,
+.cm-s-obsidian .cm-templater-command.cm-meta {
+    color: var(--code-property, #d4d4d4);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-callee,
+.cm-s-obsidian .cm-templater-command.cm-operator,
+.cm-s-obsidian .cm-templater-command.cm-qualifier,
+.cm-s-obsidian .cm-templater-command.cm-builtin {
+    color: var(--code-operator, #fc4384);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-tag {
+    color: var(--code-tag, #fc4384);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-comment,
+.cm-s-obsidian .cm-templater-command.cm-comment.cm-tag,
+.cm-s-obsidian .cm-templater-command.cm-comment.cm-attribute {
+    color: var(--code-comment, #696d70);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-string,
+.cm-s-obsidian .cm-templater-command.cm-string-2 {
+    color: var(--code-string, #e6db74);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-header,
+.cm-s-obsidian .cm-templater-command.cm-hr {
+    color: var(--code-keyword, #da7dae);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-link {
+    color: var(--code-normal, #696d70);
+}
+
+.cm-s-obsidian .cm-templater-command.cm-error {
+    border-bottom: 1px solid #c42412;
+}
+
+.CodeMirror-hints {
+    position: absolute;
+    z-index: 10;
+    overflow: hidden;
+    list-style: none;
+
+    margin: 0;
+    padding: 2px;
+
+    -webkit-box-shadow: 2px 3px 5px rgba(0, 0, 0, 0.2);
+    -moz-box-shadow: 2px 3px 5px rgba(0, 0, 0, 0.2);
+    box-shadow: 2px 3px 5px rgba(0, 0, 0, 0.2);
+    border-radius: 3px;
+    border: 1px solid silver;
+
+    background: white;
+    font-size: 90%;
+    font-family: monospace;
+
+    max-height: 20em;
+    overflow-y: auto;
+}
+
+.CodeMirror-hint {
+    margin: 0;
+    padding: 0 4px;
+    border-radius: 2px;
+    white-space: pre;
+    color: black;
+    cursor: pointer;
+}
+
+li.CodeMirror-hint-active {
+    background: #08f;
+    color: white;
+}

package/karaoke-create-vault/blog/draft-post.md

@@ -0,0 +1,15 @@
+---
+title: Draft Post
+publish: false
+date: 2026-01-02
+---
+
+This post has `publish: false`. It lives in your vault but never appears on the site.
+
+Change it to `publish: true` when you're ready to share it.
+
+## Tips for drafting
+
+- Write freely — nothing here ships until you say so
+- Use `date:` to pre-date a post for scheduling context
+- `tags:` and `description:` can be added before publishing

package/karaoke-create-vault/blog/hello-world.md

@@ -0,0 +1,26 @@
+---
+title: Hello World !
+publish: true
+date: 2026-01-01
+author: The Team
+description: Your first published post.
+---
+
+Welcome! This post has `publish: true` so it appears on your site.
+
+## How publishing works
+
+Every file in your vault is private by default. To make a note public:
+
+1. Add `publish: true` to the frontmatter
+2. Push to `main` — GitHub Actions builds and deploys automatically
+
+That's it. No config, no CMS, no dashboard. The vault is your editorial system.
+
+## What you can write
+
+- Use standard Markdown: headers, lists, code blocks, images
+- Link between notes with `[[wikilinks]]` — karaoke-cms resolves them automatically
+- Drafts with `publish: false` live in your vault and never ship to production
+
+See [[karaoke-cms/manual/content]] for the full content guide.

package/karaoke-create-vault/docs/getting-started.md

@@ -0,0 +1,49 @@
+---
+title: "Getting Started"
+publish: true
+date: 2026-01-01
+description: "How to set up and use your karaoke-cms site."
+---
+
+## Open in Obsidian
+
+Your project root is an Obsidian vault. Open this folder in Obsidian to write content with full wikilink navigation, templates, and graph view.
+
+## Configure your site
+
+Edit `karaoke.config.ts` to set your title, theme, and modules:
+
+```ts
+const config: KaraokeConfig = {
+  title: "My Site",
+  description: "What this site is about.",
+  theme: "default",       // or "minimal"
+  modules: {
+    search: { enabled: true },
+  },
+};
+```
+
+## Write content
+
+- **Blog posts** → `content/blog/`
+- **Documentation** → `content/docs/`
+- Add `publish: true` to make a file public
+- Push to `main` → your site deploys automatically via GitHub Actions + Cloudflare Pages
+
+## Frontmatter reference
+
+```yaml
+---
+title: "My Post"          # required
+publish: true             # required to appear on site
+date: 2026-01-15          # optional, YYYY-MM-DD
+author: "Name"            # optional
+description: "..."        # optional, used in OG tags and RSS
+tags: [tag1, tag2]        # optional
+---
+```
+
+## Learn more
+
+The **[[karaoke-cms/manual/index|Handbook]]** explains everything — it lives inside your vault and is visible at `/karaoke-cms` in dev mode.

package/karaoke-create-vault/karaoke-cms/config/collections.yaml

@@ -0,0 +1,10 @@
+collections:
+  blog:
+    modes: [dev, prod]
+    label: Blog
+  docs:
+    modes: [dev, prod]
+    label: Docs
+  karaoke-cms:
+    modes: [dev]
+    label: Handbook

package/karaoke-create-vault/karaoke-cms/manual/configuration.md

@@ -0,0 +1,77 @@
+---
+title: "Configuration"
+---
+
+# Configuration
+
+> **Handbook — dev only.**
+
+## karaoke.config.ts
+
+The main config file at your project root. TypeScript — fully typed.
+
+```ts
+import type { KaraokeConfig } from '@karaoke-cms/astro';
+
+const config: KaraokeConfig = {
+  title: "My Site",
+  description: "What this site is about.",
+  theme: "default",         // "default" | "minimal"
+  modules: {
+    search: {
+      enabled: true,        // Pagefind full-text search
+    },
+    comments: {
+      enabled: true,        // Giscus (GitHub Discussions)
+      repo: "owner/repo",
+      repoId: "R_...",
+      category: "General",
+      categoryId: "DIC_...",
+    },
+  },
+};
+
+export default config;
+```
+
+Get Giscus values from [giscus.app](https://giscus.app) after enabling Discussions on your repo.
+
+## collections.yaml
+
+`content/karaoke-cms/config/collections.yaml` controls which collections are visible in dev vs prod:
+
+```yaml
+collections:
+  blog:
+    modes: [dev, prod]   # visible in both dev and production
+    label: Blog
+  docs:
+    modes: [dev, prod]
+    label: Docs
+  karaoke-cms:
+    modes: [dev]         # dev-only — never ships
+    label: Handbook
+```
+
+To add a custom collection (e.g., `content/notes/`):
+
+```yaml
+collections:
+  notes:
+    modes: [dev, prod]
+    label: Notes
+```
+
+## Layout regions
+
+Place UI components in the sidebar or header via `karaoke.config.ts`:
+
+```ts
+layout: {
+  regions: {
+    right: { components: ['recent-posts'] },
+  },
+},
+```
+
+Available components: `header`, `main-menu`, `search`, `recent-posts`, `footer`.

package/karaoke-create-vault/karaoke-cms/manual/content.md

@@ -0,0 +1,38 @@
+---
+title: "Writing Content"
+---
+
+# Writing Content
+
+> **Handbook — dev only.**
+
+## Frontmatter fields
+
+```yaml
+---
+title: "My Post"            # required — build fails without it
+publish: true               # required to appear on site (default: false)
+date: 2026-01-15            # optional — YYYY-MM-DD, used for sorting
+author: "Name"              # optional — string or array ["Alice", "Bob"]
+description: "..."          # optional — used in OG meta tags and RSS
+tags: [writing, tutorial]   # optional — enables tag pages at /tags/[tag]
+---
+```
+
+## Privacy model
+
+Every file is **private by default**. `publish: false` (or a missing `publish` field) means the file stays in your vault and never enters the build — not in HTML, not in RSS, not in the sitemap, not in the Pagefind search index.
+
+Only `publish: true` files appear on your site.
+
+## Wikilinks
+
+Use `[[slug]]` syntax to link between notes. karaoke-cms resolves wikilinks automatically:
+
+- `[[blog/hello-world]]` → `/blog/hello-world/`
+- `[[docs/getting-started]]` → `/docs/getting-started/`
+- `[[docs/getting-started|Getting Started]]` → link text "Getting Started"
+
+## AI enrichment (optional)
+
+Run `npx @karaoke-cms/enrich` to auto-generate `tags`, `description`, and `reading_time` for published notes using OpenAI or Anthropic. Skips already-enriched notes via a local cache.

package/karaoke-create-vault/karaoke-cms/manual/deployment.md

@@ -0,0 +1,46 @@
+---
+title: "Deployment"
+---
+
+# Deployment
+
+> **Handbook — dev only.**
+
+## Cloudflare Pages (recommended)
+
+1. Push your project to a GitHub repo
+2. Go to [Cloudflare Pages](https://pages.cloudflare.com) → Create a project → Connect to your repo
+3. Build settings:
+   - **Build command:** `npm run build`
+   - **Build output directory:** `dist`
+   - **Node.js version:** 22
+4. Deploy
+
+On every push to `main`, Cloudflare Pages rebuilds and redeploys automatically.
+
+## GitHub Actions (privacy gate)
+
+The included `deploy.yml` workflow runs `assert-privacy` on every build to verify that no private content leaks into `dist/`. If a private note accidentally gets into the build, the deploy fails before it reaches production.
+
+## Custom domain
+
+In Cloudflare Pages → your project → Custom domains → Add a domain. Update `site:` in `astro.config.mjs` to match:
+
+```js
+export default defineConfig({
+  site: 'https://your-domain.com',
+  // ...
+});
+```
+
+## Environment variables
+
+If you use `@karaoke-cms/enrich` in CI:
+
+| Variable | Purpose |
+|----------|---------|
+| `OPENAI_API_KEY` | Required if `ENRICH_PROVIDER=openai` (default) |
+| `ANTHROPIC_API_KEY` | Required if `ENRICH_PROVIDER=anthropic` |
+| `ENRICH_ENABLED` | Set to `true` to enable AI enrichment in CI |
+| `CLOUDFLARE_API_TOKEN` | For Cloudflare Pages deploy via GitHub Actions |
+| `CLOUDFLARE_ACCOUNT_ID` | For Cloudflare Pages deploy via GitHub Actions |

package/karaoke-create-vault/karaoke-cms/manual/index.md

@@ -0,0 +1,41 @@
+---
+title: "Handbook"
+---
+
+# karaoke-cms Handbook
+
+> **Handbook — dev only.** This section is visible at `/karaoke-cms` in dev mode and never ships to production.
+
+karaoke-cms is an Astro framework for publishing Obsidian vaults as static sites. Private-by-default: only files with `publish: true` in frontmatter appear on your site.
+
+## How it works
+
+```
+Obsidian vault (this directory)
+  ↓  write notes with publish: true
+  ↓  push to main
+  ↓  GitHub Actions: astro build + assert-privacy
+  ↓  Cloudflare Pages
+  ↓  live site
+```
+
+Your vault is also your deploy pipeline config, your documentation, and your content collection — all in one place.
+
+## Handbook sections
+
+- [[content]] — Writing content and frontmatter
+- [[configuration]] — karaoke.config.ts reference
+- [[deployment]] — Deploying to Cloudflare Pages
+- [[privacy]] — How publish:true works
+
+## Collections
+
+This vault has three content collections:
+
+| Collection | Mode | Purpose |
+|------------|------|---------|
+| `blog/` | dev + prod | Published blog posts |
+| `docs/` | dev + prod | Published documentation |
+| `karaoke-cms/` | dev only | This handbook — never ships |
+
+Edit `content/karaoke-cms/config/collections.yaml` to add your own collections or change their visibility.

package/karaoke-create-vault/karaoke-cms/manual/privacy.md

@@ -0,0 +1,37 @@
+---
+title: "Privacy"
+---
+
+# Privacy Model
+
+> **Handbook — dev only.**
+
+## The rule
+
+**Every file is private by default.** Only files with `publish: true` in frontmatter appear on your site.
+
+A file without `publish: true` never enters the build — not in HTML, RSS, sitemap, or the Pagefind search index.
+
+## How it's enforced
+
+Two independent layers:
+
+1. **Astro content filter** — `getCollection('blog', ({ data }) => data.publish === true)` filters at the query level. Pages only receive published entries.
+
+2. **assert-privacy** — a post-build check that scans `dist/` for known private note titles and content. If any private content leaks, the build fails before deploy.
+
+The collection mode system adds a third layer: `karaoke-cms/` is excluded from `makeCollections()` in production entirely. Even if a handbook page had `publish: true`, it would never enter the prod build graph.
+
+## What "private" means
+
+| Field | Builds? | Searchable? | In RSS? | In sitemap? |
+|-------|---------|-------------|---------|-------------|
+| `publish: true` | Yes | Yes | Yes | Yes |
+| `publish: false` | No | No | No | No |
+| missing | No | No | No | No |
+
+## Audit your site
+
+After every build, `assert-privacy.js` outputs a summary of what shipped. Check it in your CI logs.
+
+For a manual check: `node node_modules/@karaoke-cms/assert-privacy/dist/index.js dist`

package/karaoke-create-vault/karaoke-cms/templates/blog-header.md

@@ -0,0 +1,9 @@
+---
+title: ""            # required — build fails without it
+publish: false               # required to appear on site (default: false)
+date: 2026-01-15            # optional — YYYY-MM-DD, used for sorting
+author: ""              # optional — string or array ["Alice", "Bob"]
+description: ""          # optional — used in OG meta tags and RSS
+tags: [general]   # optional — enables tag pages at /tags/[tag]
+notetype: blog
+---

package/karaoke-create-vault/karaoke-cms/templates/docs-header.md

@@ -0,0 +1,9 @@
+---
+title: ""            # required — build fails without it
+publish: false               # required to appear on site (default: false)
+date: 2026-01-15            # optional — YYYY-MM-DD, used for sorting
+author: ""              # optional — string or array ["Alice", "Bob"]
+description: ""          # optional — used in OG meta tags and RSS
+tags: [general]   # optional — enables tag pages at /tags/[tag]
+notetype: blog
+---

package/karaoke-create-vault/karaoke-cms/templates/index-by-foldernote.md

@@ -0,0 +1,8 @@
+---
+title: ""            # required — build fails without it
+publish: false               # required to appear on site (default: false)
+date: 2026-01-15            # optional — YYYY-MM-DD, used for sorting
+author: ""              # optional — string or array ["Alice", "Bob"]
+description: "..."          # optional — used in OG meta tags and RSS
+tags: [general]   # optional — enables tag pages at /tags/[tag]
+---

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@karaoke-cms/create",
   "type": "module",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "Scaffold a new karaoke-cms project",
   "bin": {
     "create-karaoke-cms": "./src/index.js"
   },
   "files": [
-    "src/"
+    "src/",
+    "karaoke-create-vault/"
   ],
   "engines": {
     "node": ">=22.12.0"