Skip to content

TriptoAfsin/md-viewer-pwa

Repository files navigation

MD View logo

MD View

A sleek, lightweight Progressive Web App for viewing Markdown files on any device.
Open local .md files with the system file picker, read them beautifully formatted with syntax-highlighted code blocks, and export to PDF or plain text — all offline, all private.

Live · GitHub · Features · Getting Started · Contributing · License


MD View screenshot


Features

  • System file picker — open any .md file from your device
  • Drag & drop — drop files directly onto the page
  • Paste markdown — paste raw markdown text to preview instantly
  • Tab bar — open multiple files in tabs, switch between them, and restore tabs on reload
  • Beautiful rendering — clean, typographic Markdown display with GFM support
  • Code syntax highlighting — VS Code-quality highlighting powered by Shiki with 10 selectable themes
  • Mermaid diagrams — render flowcharts, sequence diagrams, and more from ```mermaid code blocks
  • Light & dark mode — respects system preference with manual toggle
  • Accent colors — choose from multiple accent color themes
  • Export to PDF — text-based, selectable PDF output via jsPDF
  • Export to plain text — stripped markdown formatting
  • Context menu — copy, export, and open files from right-click or long-press
  • Recent files — quickly reopen previously viewed files
  • File handling — register as default app for .md files on supported platforms
  • Mobile-first — optimized for phones and tablets, works great on desktop too
  • Offline-ready — full PWA with service worker, install it and use it anywhere
  • Privacy-first — files never leave your device, zero server processing

Tech Stack

Getting Started

# Install dependencies
npm install

# Start dev server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feat/my-feature)
  3. Commit your changes (git commit -m 'Add my feature')
  4. Push to the branch (git push origin feat/my-feature)
  5. Open a Pull Request

License

MIT


Made with 💝 by TriptoAfsin

About

A sleek, lightweight Progressive Web App for viewing Markdown files on any device

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors