What problem does it solve?
Provides a distraction-free, book-like way to read long-form Markdown and browse Markdown directories in a browser without manual HTML authoring or complex build steps. It solves the friction of previewing documentation, novels, reports, and plan-driven content by serving rendered HTML with sensible typography, theme switching, and navigation built in. The server also handles image path resolution and safe file serving so local media and linked files display reliably.
Core Features & Use Cases
- Novel Theme: Warm, readable typography, narrow content width, dark mode, and reader-first UI for long-form consumption.
- Directory Browser: Browse folders with clickable markdown links and parent navigation for quick exploration of a project or writing folder.
- Mermaid Diagram Support: Client-side mermaid rendering with theme-aware re-rendering and expand/collapse controls for diagrams.
- Plan Navigation: Auto-detects plan structures, generates a sidebar with phase anchors, and provides previous/next navigation for multi-file plans.
- Robust Server UX: Background/foreground modes, automatic port selection, PID management, safe path validation, and /file routes for serving local images.
- Use Case: Preview a documentation folder, read a long README or novel draft in a calm reader UI, or review plan-phase files with inline navigation.
Quick Start
Start the server pointing at a markdown file or directory, then open the printed URL in your browser to begin reading.