-
Notifications
You must be signed in to change notification settings - Fork 28
Home
Baivab Sarkar edited this page Mar 7, 2026
·
1 revision
Welcome to the Markdown Viewer wiki — your comprehensive reference for installation, configuration, and usage of the Markdown Viewer application.
Markdown Viewer is a professional, feature-rich, GitHub-style Markdown editor and live-preview application that runs entirely in the browser. It provides real-time rendering, syntax highlighting, LaTeX math support, Mermaid diagrams, and much more — all without requiring any server-side processing, sign-up, or data uploads.
Privacy First: All content is processed locally in your browser. Nothing you type is ever sent to a server.
| Platform | Quick Command |
|---|---|
| Docker | docker run -p 8080:80 ghcr.io/thisis-developer/markdown-viewer:latest |
| Docker Compose | docker compose up -d |
| Desktop App | Download the binary from Releases |
| Web (self-hosted) | Serve the root directory with any static web server |
Then open http://localhost:8080 in your browser.
| Page | Description |
|---|---|
| Installation | Set up the application on Web, Docker, or Desktop |
| Usage Guide | Learn how to write, preview, import, and export |
| Features | Explore all supported features in detail |
| Markdown Reference | Complete syntax reference for all supported elements |
| Desktop App | Build and run the native desktop application |
| Docker Deployment | Deploy with Docker and Docker Compose |
| Configuration | Configure the application and its build tools |
| Contributing | How to contribute to the project |
| FAQ | Frequently asked questions |
- 🖊️ Live Split-Screen Editor — Write on the left, see rendered output on the right in real-time
- 🌙 Dark / Light Mode — Toggle themes instantly with CSS variables
- 💡 Syntax Highlighting — 190+ programming languages via highlight.js
- 📐 LaTeX Math — Inline and block mathematical expressions via MathJax
- 📊 Mermaid Diagrams — Flowcharts, sequence diagrams, Gantt charts, and more
- 📤 Export Options — Save as Markdown, HTML, or PDF
- 📥 File Import — Drag & drop or file-picker import of
.mdfiles - 🔗 Share via URL — Share content by compressing it into the URL
- 📋 Copy to Clipboard — One-click copy of the rendered HTML
- 📊 Content Statistics — Word count, character count, and estimated reading time
- 😀 Emoji Support — Full emoji set via JoyPixels
- 📱 Responsive Design — Works on desktop, tablet, and mobile
- 🔒 Privacy Focused — 100% client-side, no server required
| Category | Technology |
|---|---|
| Markup / Rendering | marked.js 9.1.6 |
| Syntax Highlighting | highlight.js 11.9.0 |
| Math Rendering | MathJax 3.2.2 |
| Diagram Rendering | Mermaid 11.6.0 |
| HTML Sanitization | DOMPurify 3.0.9 |
| UI Framework | Bootstrap 5.3.2 |
| Desktop Runtime | Neutralinojs 6.5.0 |
| Containerization | Docker / Nginx Alpine |