Skip to content
klpplPublic

About

Publish your Obsidian notes as a self-hosted digital garden. Pick what's public, press Publish, and get a fast, searchable site with wikilinks, backlinks, a graph and search. It's one small Go server in Docker.

Topics

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

kvist

License: Lagom 100% vibecoded Made with love Code reviewed by

🌿 Disclosure: every line of kvist was vibecoded. Lovingly. By someone who knows what a race condition is, reads the diffs, and has said "no, that's wrong, try again" more times than they've said "ship it". The vibes are immaculate; the tests still have to pass.

Publish your Obsidian notes as a website you own.

kvist (Swedish for "twig") turns the notes you choose into a fast, searchable digital garden on your own server. Write in Obsidian, press Publish, and your site updates. Private notes never leave your device.

A kvist site: a menu with a profile and folder tree, a list of the notes beside it, and a note with callouts and code

  • Obsidian syntax: wikilinks, embeds, callouts, tags, footnotes, math, Mermaid diagrams and canvases.
  • Private stays private: you choose what's public by folder, tag or property, and the server checks every note again. Links to private notes become plain text.
  • Your folder is the site: publish one folder from your vault and it becomes the site's root, so its subfolders are the menu and the folder's name stays out of every address. Folders list their newest notes first; a sort property makes one A–Z or by date planted, and order pins a note to the top. An icon property gives a folder an emoji or icon.
  • Search, backlinks, related notes, link previews and a graph, in a three-pane theme with light and dark mode, breadcrumbs, a reader mode, instant page loads and optional stacked pages that open linked notes side by side. Search filters by #tag, images open full size with a click, and a note's cover: shows beside its title in lists (cards without one can get a generated color cover).
  • Page layouts: layout: about gives a page about you with a portrait and your profile links, intro a welcome page with a banner and a large title, cover a post under a wide picture, page a page without dates.
  • Shares well: every note gets a preview image with its title for chats and social media, and unlisted: true publishes a note without listing it anywhere.
  • Settings in a note: the site's title, home page, profile, menu links and colors live in _site.md, so you change them from Obsidian on any device.
  • Links keep working: a renamed or moved note's old address redirects to the new one.
  • In your language: the theme's menus, dates and search speak English, Swedish, German, French or Spanish, and the Obsidian plugin follows Obsidian's language (English and Swedish).
  • Self-hosted: one small Go server in Docker, with a ready-made Caddy setup for HTTPS and room for several sites. RSS, a sitemap, search engine metadata (Open Graph, schema.org), photo metadata stripping and optional cookie-free analytics included.

TLDR

You need a server with Docker, and an HTTPS address that forwards to 127.0.0.1:8080 on it (Cloudflare, nginx, Caddy, whatever you use). On the server:

DOMAIN=garden.example.com   # your address
mkdir -p ~/kvist && cd ~/kvist
curl -fsSLO https://raw.githubusercontent.com/klppl/kvist/main/deploy/docker-compose.yml
curl -fsSLO https://raw.githubusercontent.com/klppl/kvist/main/deploy/kvist.toml
sed -i "s/garden.example.com/$DOMAIN/g" kvist.toml
docker compose up -d
docker compose exec kvist kvist token create   # copy the token

Then unzip kvist-plugin.zip into your vault's .obsidian/plugins/, enable kvist, enter your domain, site garden and the token, put a note in a Kvist folder and run kvist: Publish now. Step by step: TLDR: quick setup.

Get started

Read the documentation →

The server runs from the Docker image ghcr.io/klppl/kvist. The Obsidian plugin works on desktop and mobile: download kvist-plugin.zip and unzip it into your vault's .obsidian/plugins/ folder (details).

Development

make check          # everything CI runs
make build          # bin/kvist
make test           # Go tests
make plugin-test    # plugin tests
make dev            # preview the demo site on http://127.0.0.1:1313

Requires Go 1.26 or later, and Node 20+ for the plugin. Read AGENTS.md and CONTRIBUTING.md before changing anything that affects what gets published. Developer notes: design, sync protocol, content model, themes, deployment. The user guide's source is docs/*.html.

Licensed under the Lagom License.

About

Publish your Obsidian notes as a self-hosted digital garden. Pick what's public, press Publish, and get a fast, searchable site with wikilinks, backlinks, a graph and search. It's one small Go server in Docker.

Topics

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages