More

Roadmap

What kvist can't do yet, and what is planned. There are no dates: things get built roughly in the order below, and what people ask for moves up. To ask for something, open an issue on GitHub.

What doesn't work yet

Everything else from Obsidian is in Writing notes. These don't work on the site today:

  • Queries from plugins such as Dataview or Bases show as code blocks, not as their results.
  • Excalidraw drawings show only if you embed an exported SVG or PNG, not the drawing itself.
  • Markdown-style embeds of notes, ![text](Note.md), are left out. Use ![[Note]].
  • Other plugins' own syntax is shown as written.
  • Sites under a sub-path: base_url must be the root of a domain, like https://garden.example.com, not https://example.com/garden/.
  • Installing the plugin is by hand: it isn't in Obsidian's community plugin list yet.

Planned

Writing

  • Markdown-style note embeds. ![text](Note.md) embeds the note like ![[Note]] does.
  • Excalidraw. Show a drawing from the SVG or PNG the Excalidraw plugin exports next to it, when you link or embed the drawing itself.
  • Citations. [@key] resolved from a BibTeX file in your vault, with a bibliography at the end of the note.

The site

  • Your own CSS from the vault. A publish.css in your vault, applied after the theme's styles, so small style changes don't need the server.
  • Ordering and hiding menu entries. Choose the order of folders and groups, and hide some from the menu without unpublishing them.
  • Comments. An optional comment section under notes, using giscus.
  • Password-protected sites. One password for the whole site, or for a folder.

Addresses and hosting

  • Old addresses you list yourself. A redirect_from property with a note's old addresses, for moves that automatic redirects can't follow.
  • Sites under a sub-path, like https://example.com/garden/.
  • Ready-made programs. kvist for Linux, macOS and Windows on each release, so kvist dev and kvist build work on your own computer without Go.
  • The community plugin list. Install the plugin from inside Obsidian.

Recently added

  • Links at the top of the menu: primary_links in the settings note puts links next to Home, Search, Graph and Tags, and secondary_links lists the ones under Links (Customizing).
  • Generated covers: with generated_covers: true, cards without a picture get a cover in soft colors, each note always the same one, so folder and home pages don't look empty (Customizing).
  • Related notes: under each note, up to five notes with words, tags or linked notes in common that it doesn't link to yet. The server works them out when it builds the site, without sending your notes anywhere (Customizing).
  • Cover images in lists: a note's image or cover shows as a small square beside its title in the list, and atop its card on folder pages. The server makes small copies, so lists stay fast (Writing notes).
  • Images full size: click an image in a note to see it over the page; ← and → step through the note's images (Writing notes).
  • The order of notes: folders list their newest notes first; a sort property on a folder note lists them A–Z or by date planted, and order pins a note to the top (The order of notes).
  • Folder icons: an icon property on a folder note, an emoji or an icon name, replaces the plain folder in the menu and lists (Folder icons).
  • The plugin in Swedish: it follows Obsidian's language.
  • Removing a site with kvist site delete, and a Reset settings button in the plugin for moving a vault to another site (Running the server).
  • Canvases: .canvas files are published as a page with their cards and arrows, and can be embedded with ![[Board.canvas]] (Canvases).
  • Code block extras: a title (```go title="main.go"), line numbers and highlighted lines (Writing notes).
  • Stacked pages: with stacked_pages, linked notes open side by side, as panes that slide.
  • Your published folder is the site's root: its subfolders are the top of the menu, and its name stays out of addresses (root_folder).
  • Instant navigation: pages open without a full reload, and the menu keeps its place.
  • Breadcrumbs above a note's title, and a reader mode that hides the menu and side panels.
  • Search by tag: #tag in the search box filters the results.
  • Preview images with the note's title, for sharing in chats and on social media.
  • Unlisted notes: unlisted: true publishes a note without listing it anywhere.
  • Search engine metadata: structured data for articles and breadcrumbs, sitemap dates for every page, one address per page, image sizes, alt text from file names and no thin tag pages in search results.
  • Redirects for moved notes, a folder tree in the menu, a copy button on code, analytics settings, favicons and the interface in five languages.