Documentation Overview

karaoke-cms is an Astro framework that turns an Obsidian vault into a fast static site. Everything stays private by default — only notes with publish: true go live.

Sections

User Manual

Step-by-step guides for getting started and configuring your site. Covers installation, writing content, privacy, wikilinks, modules (blog, docs, tags, search, SEO, comments), theming, menus, deployment, and building your own modules and themes.

Start here if you are new to karaoke-cms.

Reference

Lookup tables for every option, field, and schema. Configuration (karaoke.config.ts), frontmatter fields, module signatures, menus.yaml syntax, collection settings, and the changelog.

Start here when you already know what you are looking for.