Professional GitHub-style Markdown editor and previewer
Live preview, diagrams, math, export tools, and multi-document workflows — all in your browser.
Live Demo · Documentation · Issues · Releases
- About the Project
- Features
- Screenshots
- Getting Started
- Usage
- Documentation
- Built With
- Showcase
- Contributing
- Contributors
- Development Journey
- License
- Contact
Markdown Viewer is a full-featured Markdown editor and preview application that renders GitHub-flavored Markdown in real time. It is entirely client-side, lightweight, and optimized for a professional writing workflow — from quick notes to technical documentation with diagrams and LaTeX.
Editor & Preview
- Live split-screen rendering with instant updates
- GitHub-flavored Markdown (GFM) support
- Syntax highlighting for 190+ languages
- GitHub-style alerts/admonitions (
[!NOTE],[!TIP],[!WARNING], etc.) - Emoji shortcode rendering (JoyPixels) and native Unicode emoji support
- YAML frontmatter parsing with a rendered metadata table
Diagrams & Math
- LaTeX math rendering via MathJax (inline + block)
- Mermaid diagrams with an interactive toolbar (zoom, pan, copy, PNG/SVG export)
File & Sharing Tools
- Import from local files, drag & drop, or public GitHub URLs (multi-file selection)
- Export as Markdown, HTML (standalone), or PDF
- Share documents via URL with compressed content
- Copy rendered HTML directly to clipboard
Productivity & Workflow
- Multiple document tabs (new, rename, duplicate, delete)
- Reset all tabs in one action
- Drag-and-drop tab reordering
- Tab/session state saved in localStorage
- View modes: editor-only, preview-only, or split
- Resizable editor/preview panes
- Synchronized scrolling (toggleable)
- Live content statistics (words, characters, reading time)
- Keyboard shortcuts (export, copy, new/close tab, sync toggle, indentation)
UI & Accessibility
- Responsive layout with a dedicated mobile menu
- Light/dark themes with system preference support
Privacy & Security
- 100% client-side processing
- Sanitized HTML rendering with DOMPurify
- No tracking, no cookies, no server storage
docker run -d \
--name markdown-viewer \
-p 8080:80 \
--restart unless-stopped \
ghcr.io/thisis-developer/markdown-viewer:latestOpen http://localhost:8080.
git clone https://github.com/ThisIs-Developer/Markdown-Viewer.git
cd Markdown-Viewer
docker compose up -dgit clone https://github.com/ThisIs-Developer/Markdown-Viewer.git
cd Markdown-Viewer
python3 -m http.server 8080Download pre-built binaries from the Releases page or build from source (see the Desktop App guide).
- Write Markdown in the left editor pane.
- Preview the rendered output on the right.
- Import, export, share, or switch view modes using the toolbar.
- Use the tab bar to manage multiple documents.
Keyboard Shortcuts
Ctrl/Cmd + S→ Export MarkdownCtrl/Cmd + C→ Copy rendered HTML (when no text is selected)Ctrl/Cmd + Shift + S→ Toggle sync scrolling (split view)Ctrl/Cmd + T→ New tabCtrl/Cmd + W→ Close tabTab→ Insert indentation in editor
Explore the full documentation on the wiki:
- HTML5, CSS3, JavaScript
- Bootstrap
- Marked.js
- highlight.js
- MathJax
- Mermaid
- DOMPurify
- FileSaver.js
- html2canvas + jsPDF
- JoyPixels
Built with Markdown Viewer
| Project | Description |
|---|---|
| Markdown Desk | Native macOS wrapper built with Tauri, adding live reload and native file open/save. |
Contributions are welcome! Please review the Contributing Guide and open a pull request.
Thanks to everyone who has contributed to Markdown Viewer.
Markdown Viewer has grown from a lightweight Markdown parser into a full-featured, professional application with advanced rendering, workflow, and export capabilities. Compare the current version with the original version to see the progress in UI design, performance optimization, and feature depth.
This project is licensed under the Apache License. See LICENSE for details.
Developed and maintained by ThisIs-Developer.