Skip to content

Latest commit

 

History

44 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
QvReader

QvReader

Ultra-lightweight, instant Markdown reader and editor for macOS and Windows

Open a .md file and read it like a clean web page — sub-50ms cold launch, instantaneous response. Distraction-free and document-focused.
Press F2 to edit inline, press F3 for live synchronized split preview. Hit Esc when finished to close instantly.

Version Website License Platform

Languages: English · 简体中文 · 日本語 · 한국어 · Español · Português (Brasil)


Why QvReader?

Most Markdown editors are built for heavy document authoring or complex networked databases. QvReader is built specifically for instant reading and lightweight editing of local Markdown files — READMEs, AI-generated code documentation, technical specifications, meeting notes, and release announcements.

  • ⚡ Ultra-Fast Native Performance: Powered by Rust and Tauri, with a ~5MB compact binary footprint, a 614KB JS entry bundle, and sub-50ms cold startup. Effortlessly renders 50,000+ line documents at 60 FPS smooth scrolling.
  • 📐 Screen-Adaptive Fluid Layout: Dynamic width management (896px–1280px) eliminating excessive margin whitespace on wide monitors, offering 3 layout modes: adaptive, standard, and full.
  • 📊 Mermaid Diagram Zoom Modal: Native rendering of flowcharts, sequence diagrams, and architecture graphs with an interactive double-click modal for panning, dragging, and full-screen inspection.
  • 📤 4-Way Export Pipeline: Ink-friendly Print (Cmd/Ctrl+P), high-fidelity vector PDF (Cmd/Ctrl+Shift+P), 2x Retina PNG with auto-clipboard sync (Cmd/Ctrl+Shift+E), and standalone self-contained offline HTML (Cmd/Ctrl+Shift+H).
  • 🔒 Local-First & Pure Privacy: Your documents never leave your local disk. No internet connection required, zero document telemetry, and no mandatory account sign-up.
  • ⌨️ Minimal Interaction Contract: Double-click .md to open instantly in reading mode; press Esc to close; press F2 to edit inline; press F3 for live split preview.

Downloads & Mirrors

Download the v0.1.4 installer from GitHub Releases or verified high-speed CDN mirrors:

Platform / Architecture Package File Official GitHub Releases Fast Mirror 1 (ghfast) Fast Mirror 2 (gh-proxy)
macOS (Apple Silicon) QvReader-0.1.4-arm64.dmg Download Fast Mirror Alternate
macOS (Intel x64) QvReader-0.1.4-x64.dmg Download Fast Mirror Alternate
Windows (x64 Installer) QvReader-0.1.4-x64-setup.exe Download Fast Mirror Alternate
Windows (x64 Portable) QvReader-0.1.4-windows-x64.zip Download Fast Mirror Alternate
Linux (x64 AppImage) QvReader-0.1.4-amd64.AppImage Download Fast Mirror Alternate

Checksums and earlier versions are available on the GitHub Releases Page.


Installation & Security Trust Guidance

QvReader community packages are built with full transparency via GitHub Actions CI with published SHA256 checksums. Until official commercial EV code signing certificates are applied, OS security tools may show an unsigned developer dialog. Please follow these simple steps to trust and launch the application:

macOS (Apple Gatekeeper)

If macOS shows: "QvReader cannot be opened because the developer cannot be verified" or "The app is damaged and can’t be opened":

  1. GUI Quick Trust:
    • Drag QvReader.app into /Applications.
    • Right-click (or Control-click) QvReader.app and choose Open.
    • In the system prompt dialog, click Open. The app will launch and will not prompt again.
  2. Terminal One-Liner (Recommended):
    xattr -cr /Applications/QvReader.app

Windows (Microsoft Defender SmartScreen)

If Windows displays a blue modal stating: "Windows protected your PC":

  1. Click the "More info" link inside the dialog.
  2. Click the "Run anyway" button that appears in the bottom right corner.

Key Shortcuts

Action / Mode Shortcut (macOS) Shortcut (Windows/Linux) Description
Inline Edit F2 F2 In-place editing on the reading canvas; 100% permanently free
Split Preview F3 F3 Side-by-side source code and live synchronized preview
Exit / Close Esc Esc Exits edit mode; immediately closes the window when unmodified
Save Document Cmd + S Ctrl + S Saves preserving line endings (LF/CRLF) and encoding (UTF-8)
Print Document Cmd + P Ctrl + P System native print dialog with ink-friendly styling
Export to PDF Cmd + Shift + P Ctrl + Shift + P High-fidelity vector PDF generation
Export to Retina PNG Cmd + Shift + E Ctrl + Shift + E 2x Retina full-page screenshot with automatic clipboard copy
Export to Standalone HTML Cmd + Shift + H Ctrl + Shift + H Self-contained offline HTML file bundle
Settings Center Cmd + , Ctrl + , Themes, layout modes (adaptive/standard/full), and font adjustments

Editions, Privacy & Commercial Boundaries

QvReader adheres to a transparent, local-first commercial model:

  • 100% Open-Source Client:
    • The complete desktop client source code (React UI, markdown parser, Tauri Rust core, offline entitlement verifier) is available under the Apache License 2.0.
    • Build directly from source using npm ci && npm run build without proprietary dependencies.
    • In local development (NODE_ENV !== 'production'), Pro features are unlocked by default so contributors can test freely.
  • Redistribution & Trademark Rules:
    • You are free to fork, modify, and redistribute under Apache-2.0.
    • Forks and unofficial builds MUST identify as a "Community Build" or "非官方构建" in the window title and About dialog per TRADEMARKS.md.
    • Official code signing certificates (Apple notarization, Windows Authenticode) are reserved exclusively for official maintainer distributions.
  • Privacy & Local-First Guarantees:
    • QvReader operates completely offline. Document contents and file paths are never transmitted to remote servers.
    • Pro activation transmits only an anonymized device hash, device label, and license key over TLS.
    • License validation failures never lock, modify, or block saving local Markdown files.
  • Community vs. Pro Editions (Official Distributions):
    • Community Edition: Core reading and F2 inline editing are 100% free with no time limits or ads. F3 split-view includes evaluation trial sessions with zero lockouts on document saving.
    • Pro Edition ($9.99 One-Time Lifetime Buyout): One-time buyout for 3+ devices, 100% local offline activation, zero subscriptions via qvreader.com.
  • Support Scope:
    • Technical support from maintainers is provided for official distributions per SUPPORT.md. Forks are supported by their respective creators.

Documentation & Community


License & Trademarks

About

Ultra-lightweight Markdown reader & editor for macOS, Windows & Linux — built with Tauri, opens local .md files in milliseconds. Distraction-free reading with instant in-place (F2) and split (F3) editing. Apache-2.0, no telemetry.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages