Obsidian Site

A self-hostable, statically generated documentation site powered by your Obsidian vault.

Obsidian Site turns your Obsidian vault into a fully static, fast, and beautiful website — without any server-side runtime. Write in Obsidian, deploy anywhere.

---

Quick Navigation

📖 General

• Project Overview — What this project is and what it can do
• Roadmap — Planned and future features

📝 How to Document

• Getting Started — Set up your first documentation site
• Deployment — Deploy to Netlify, Vercel, Cloudflare Pages, or self-host
• Components — Callouts, code blocks, wikilinks, embeds, and more
• Using Canvas — Visualize ideas with interactive canvas files
• Customization — Configure your site via vault.config.ts

🛠 How to Develop

• Setup — Clone the repo and run locally
• Building — Build your site for production
• Project Structure — Directory layout and architecture
• Tech Stack — Technologies used in this project
• Testing — Run the test suite and check coverage
• Pre-commit Hooks — Quality gates on every commit

🎨 Canvas

• Architecture — Interactive canvas overview of the system

💙 Credits

• Credits — Libraries, tools, and inspiration

---

What makes it different?

Feature	Obsidian Publish	Obsidian Site
Cost	Monthly subscription	Free & self-hosted
Static output	✅	✅
Full-text search	✅	✅
Graph view	✅	✅
Canvas support	✅	✅ (beta)
Custom domain	Paid	Free
Source control	❌	✅
Open source	❌	✅