InkStone

Turn your Obsidian vault into a website.

InkStone is a Python/Flask server that reads your Obsidian vault and serves it as a live website.

Add website: true to any note — it's published.

Your folder structure becomes your URL structure. No build step, no export.

Documentation

Get Started — Three ways to run InkStone and your first published note.

Writing — How to write and publish notes with InkStone.

  • Publishing Notes — The minimum frontmatter to publish a note, plus all optional fields.
  • Frontmatter Reference — Every frontmatter field InkStone recognises, with type and example.
  • Markdown Features — Callouts, checkboxes, highlights, math, footnotes, and syntax highlighting.
  • Links and Embeds — Wiki-links, aliases, anchors, block references, and note transclusion.
  • Images and Media — Lightbox images, sliders, float layout, centered figures, captions, banners, video, and audio.
  • Dataview Queries — Server-side TABLE and LIST queries with FROM, WHERE, SORT, LIMIT, and GROUP BY.
  • Canvas Boards — Publish Obsidian .canvas files as interactive boards with pan, zoom, and node previews.
  • Obsidian Bases — Publish .base table views as auto-updating post indexes with filters and sorting.
  • Note Templates — Create notes with correct InkStone frontmatter using QuickAdd or Obsidian's Templates plugin.

Site Structure — How vault folders, file types, and frontmatter map to URLs and pages.

  • URL Mapping — How vault folder paths become website URLs.
  • Page Types — homepage, listing, book, and translations — what each type does.
  • Navigation — How nav links are generated, how to pin standalone pages, and breadcrumb behaviour.

Features — Theming, search, multilingual, private notes, SEO, and more.

  • Theming — Dark/light/system mode toggle, default theme, and built-in themes.
  • Branding — Favicon override, site icon beside the title, and per-section header title — all via frontmatter.
  • Search and Tags — Full-text search, tag pages, tags index, and inline hashtags.
  • Multilingual — Publish notes in multiple languages with filename suffixes and UI translations.
  • Private Notes — Per-note access tokens and the master ACCESS_TOKEN for protecting content.
  • Comments — Add a Giscus comment section to posts using GitHub Discussions as the backend.
  • Social Links — Add social profile links to the site footer — icon + handle, detected automatically from the URL.
  • SEO and Feeds — RSS feeds, sitemap, OpenGraph meta tags, JSON-LD structured data, and print styles.

Deployment — Local development, Docker, and production deployment options.

  • Local Development — Run InkStone locally with hot-reload for writing and development.
  • Docker — Run InkStone in a container — pull the pre-built image or build from source.
  • Production Deployment — Deploy with Coolify, configure webhooks, and set up SSL.