piotr/obsidian-livesync-fs
Watch
1
0
Fork
You've already forked obsidian-livesync-fs
 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions

feat: Read-only web viewer for Obsidian notes #4

New issue
Open
opened 2026-10-25 20:59:35 -07:00 by piotr · 0 comments
piotr commented 2026-10-25 20:59:35 -07:00
Owner

Overview

Expose a lightweight, responsive, read-only web application to browse, search, and read all vault notes directly in a web browser without launching the Obsidian desktop or mobile application.

Goals & Requirements

  • Read-Only Vault Serving:
    • Serve all notes and attachments directly from the local filesystem vault.
    • Strictly enforce read-only access (no write, update, or delete endpoints).
  • Obsidian Markdown Rendering:
    • Render GitHub-flavored markdown with Obsidian extensions: [[wikilinks]] resolution, callouts (> [!NOTE]), checkboxes, syntax highlighting.
    • Resolve embedded media/images (![[image.png]]).
  • Navigation & Search:
    • Interactive directory tree explorer matching vault folders.
    • Fast client-side or server-side full-text search across all notes.
    • Note graph view or backlink explorer (optional enhancement).
  • Security & Access Control:
    • Optional basic auth or token authentication to protect personal notes from unauthorized access.

Acceptance Criteria

  • Web server runs and displays notes in a clean, readable layout.
  • Wikilinks navigate between vault notes seamlessly.
  • Any state-modifying requests (POST/PUT/DELETE) are blocked or rejected.
  • Assets and embedded images render accurately.
## Overview Expose a lightweight, responsive, read-only web application to browse, search, and read all vault notes directly in a web browser without launching the Obsidian desktop or mobile application. ## Goals & Requirements - **Read-Only Vault Serving**: - Serve all notes and attachments directly from the local filesystem vault. - Strictly enforce read-only access (no write, update, or delete endpoints). - **Obsidian Markdown Rendering**: - Render GitHub-flavored markdown with Obsidian extensions: `[[wikilinks]]` resolution, callouts (`> [!NOTE]`), checkboxes, syntax highlighting. - Resolve embedded media/images (`![[image.png]]`). - **Navigation & Search**: - Interactive directory tree explorer matching vault folders. - Fast client-side or server-side full-text search across all notes. - Note graph view or backlink explorer (optional enhancement). - **Security & Access Control**: - Optional basic auth or token authentication to protect personal notes from unauthorized access. ## Acceptance Criteria - [ ] Web server runs and displays notes in a clean, readable layout. - [ ] Wikilinks navigate between vault notes seamlessly. - [ ] Any state-modifying requests (POST/PUT/DELETE) are blocked or rejected. - [ ] Assets and embedded images render accurately.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
piotr/obsidian-livesync-fs#4
No description provided.