Lattice turns your Obsidian vault into a website. To get started, clone the repo, copy your vault into the project folder, point publish.config.json at that folder, and run npm run dev. You do not need to convert notes or work through every setting.

Start with Quick start. The other guides are here when you need them. The project overview describes the reader and its features.

Publish a vault

  1. Quick start — clone, copy your vault, choose its folder, and run.
  2. Configuration — choose a vault, homepage, navigation, and hidden paths.
  3. Obsidian themes — use the installed theme, snippets, and CSS assets.
  4. Markdown and Bases — supported note syntax, transclusions, and data views.
  5. Security and privacy — decide what may become public.
  6. Deployment — verify output and publish to a static host.

Understand and maintain it

  • Architecture — what happens during compilation versus in the browser.
  • Troubleshooting — configuration errors, missing links, themes, and deployment paths.
  • Contributing — code locations, regression checks, and demo-content standards.

A useful boundary

This is a publisher, not an Obsidian plugin host or a private workspace service. There is no plugin execution, Dataview runtime, Canvas editing, Sync, collaboration, account system, or password protection. Bases is a supported subset, not a promise of compatibility with every Obsidian expression.

Sample notes are illustrative fixtures for rendering, navigation, and linked collections. Use them to explore the reader, then replace them with the notes you intend to publish.

Return to Welcome.