Manual

karaoke-cms is an Astro framework for publishing Obsidian vaults as static sites. You write notes in Obsidian, add publish: true to the ones you want public, and the framework builds a fast static site from them. Everything stays private by default.

Install with one command: npm create @karaoke-cms@latest.

Where to start

I’m a developer — comfortable with npm, TypeScript, and Git. I want to get a site running and understand how to configure it. Start here: Quick start for developers

I use Obsidian — I want to publish some of my notes without learning a lot of new tools. Start here: Quick start for Obsidian users