Obsidian Stats logoObsidian Stats

Vault Book

by rosfandy
5
4
3
2
1
New Plugin
Install Code

Description

Turn your vault into a Gitbook-like website - This plugin has not been manually reviewed by Obsidian staff.

Reviews

No reviews yet.

Stats

stars
downloads
0
forks
0
days
NaN
days
NaN
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

Invalid date

Changelog

See all version on GitHub

README file from

Github

Vault Book

Turn your Obsidian vault into a Gitbook-like website.

Edit notes in Obsidian, see them live in the browser. No export, no build step — just save and refresh.

Preview

Light Dark Search
Light Dark Search

Features

  • Live web server — starts from within Obsidian
  • Gitbook-style UI — sidebar nav, table of contents, search
  • Dark/Light/System theme — toggleable
  • Auto-collapsible sidebar — grouped by folder
  • Smooth scroll TOC — with active heading indicator
  • Full-text search — press Ctrl+K

Installation

From Obsidian Community Plugins

  1. Open Obsidian Settings → Community Plugins
  2. Search for "Vault Book"
  3. Install and enable

Manual (BRAT)

Add rosfandy/vault-book via the BRAT plugin.

Usage

  1. Enable the plugin in settings
  2. Run "Start Vault Book Server" from the command palette
  3. Open http://localhost:3000 in your browser
  4. Edit any note in Obsidian → refresh browser to see changes

Development

git clone https://github.com/rosfandy/vault-book.git
cd vault-book
bun install
bun run build-all

Build the React app + plugin:

bun run build-all

Project Structure

├── main.ts           # Obsidian plugin (HTTP server + API)
├── web/              # React app source
│   ├── app.tsx
│   ├── components/
│   ├── hooks/
│   └── lib/
├── build-web.ts      # esbuild script for React app
├── esbuild.config.mjs # esbuild script for plugin
└── manifest.json

License

MIT

Sponsors