craig7351/bookmdviewer

bookMDViewer is a lightweight desktop application for reading and editing Markdown files on Windows, macOS, and Linux. Markdown is a plain-text format used widely for documentation, notes, and README files, this app renders those files into formatted, readable pages with proper headings, tables, code highlighting, and diagrams. The app is built with Tauri, a framework that uses the operating system's built-in web rendering engine rather than bundling a full browser. This keeps the download size small (around 4 MB on Windows) and memory usage low. It has no network connection requirements and no telemetry. Opening a file can be done by double-clicking any .md file on your computer once the app is installed, by dragging a file into the window, or through the file open dialog. A table of contents sidebar is generated automatically from the document's headings and highlights whichever section you are currently reading. Switching to edit mode shows a split view with a live preview that updates as you type and scrolls in sync with the editor panel. Other features include in-document text search, Mermaid diagram rendering (a format for creating flowcharts and diagrams in text), HTML export that produces a single self-contained file, automatic reload when the file changes on disk, and support for YAML front matter (metadata blocks at the top of a file that display as a formatted information card rather than raw text). The README is written primarily in Traditional Chinese. Ready-to-download installers for all platforms are available on the GitHub Releases page. A portable Windows version that requires no installation is also offered. macOS users need to take an extra step on first launch because the app is not yet Apple-notarized.