You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Markdown Viewer is a professional, full-featured Markdown editor and preview application that runs entirely in your browser. It provides a GitHub-style rendering experience with a clean split-screen interface, allowing you to write Markdown on one side and instantly preview the formatted output on the other.
45
+
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.
17
46
18
-
## ✨ Features
47
+
---
48
+
49
+
## Features
50
+
51
+
**Editor & Preview**
52
+
- Live split-screen rendering with instant updates
- Light/dark themes with system preference support
83
+
84
+
**Privacy & Security**
85
+
- 100% client-side processing
86
+
- Sanitized HTML rendering with DOMPurify
87
+
- No tracking, no cookies, no server storage
19
88
20
-
-**GitHub-style Markdown rendering** - See your Markdown exactly as it would appear on GitHub
21
-
-**Live preview** - Instantly see changes as you type
22
-
-**Syntax highlighting** - Beautiful code highlighting for multiple programming languages
23
-
-**LaTeX math support** - Render mathematical equations using LaTeX syntax
24
-
-**Mermaid diagrams** - Create diagrams and flowcharts within your Markdown; hover over any diagram to reveal a toolbar for zooming, downloading (PNG/SVG), and copying to clipboard
25
-
-**Dark mode toggle** - Switch between light and dark themes for comfortable viewing
26
-
-**Export options** - Download your content as Markdown, HTML, or PDF
27
-
-**Import Markdown files** - Drag & drop, select local files, or import from public GitHub links
28
-
-**Copy to clipboard** - Quickly copy your Markdown content with one click
29
-
-**Sync scrolling** - Keep editor and preview panes aligned (toggleable)
30
-
-**Content statistics** - Track word count, character count, and reading time
31
-
-**Fully responsive** - Works on desktop and mobile devices
32
-
-**Emoji support** - Convert emoji shortcodes into actual emojis
33
-
-**100% client-side** - No server processing, ensuring complete privacy and security
34
-
-**No sign-up required** - Use instantly without any registration
89
+
---
35
90
36
-
## 📸 Screenshots
91
+
## Screenshots
37
92
38
93
### Code Syntax Highlighting
39
94
@@ -47,92 +102,114 @@ Markdown Viewer is a professional, full-featured Markdown editor and preview app
47
102
### Tables Support
48
103
49
104
50
-
## 📝 Usage
51
-
52
-
1.**Writing Markdown** - Type or paste Markdown content in the left editor panel
53
-
2.**Viewing Output** - See the rendered HTML in the right preview panel
54
-
3.**Importing Files** - Click "Import" for local files, use "GitHub Import" for repository links, or drag and drop .md files
55
-
4.**Exporting Content** - Use the "Export" dropdown to download as MD, HTML, or PDF
56
-
5.**Toggle Dark Mode** - Click the moon icon to switch between light and dark themes
57
-
6.**Toggle Sync Scrolling** - Enable/disable synchronized scrolling between panels
58
-
59
-
### Mermaid Diagram Toolbar
60
-
61
-
When a Mermaid diagram is rendered, hover over it to reveal a small toolbar with the following actions:
62
-
63
-
| Button | Action |
64
-
|--------|--------|
65
-
| ⛶ (arrows) | Open diagram in a zoom/pan modal |
66
-
| PNG | Download the diagram as a PNG image |
67
-
| 📋 (clipboard) | Copy the diagram image to the clipboard |
68
-
| SVG | Download the diagram as an SVG file |
69
-
70
-
Inside the **zoom modal** you can:
71
-
-**Zoom in / out** using the buttons or the mouse wheel
72
-
-**Pan** by clicking and dragging the diagram
73
-
-**Reset** zoom and position with the Reset button
74
-
-**Download PNG or SVG** directly from the modal
75
-
-**Close** with the × button or by pressing `Escape`
Download pre-built binaries from the [Releases](https://github.com/ThisIs-Developer/Markdown-Viewer/releases) page or build from source (see the [Desktop App](https://github.com/ThisIs-Developer/Markdown-Viewer/wiki/Desktop-App) guide).
135
+
136
+
---
137
+
138
+
## Usage
139
+
140
+
1. Write Markdown in the left editor pane.
141
+
2. Preview the rendered output on the right.
142
+
3. Import, export, share, or switch view modes using the toolbar.
143
+
4. Use the tab bar to manage multiple documents.
144
+
145
+
**Keyboard Shortcuts**
146
+
-`Ctrl/Cmd + S` → Export Markdown
147
+
-`Ctrl/Cmd + C` → Copy rendered HTML (when no text is selected)
|[Markdown Desk](https://github.com/jhrepo/markdown-desk)| A native macOS desktop wrapper built with [Tauri](https://tauri.app/), adding live reload and native file open/save (`Cmd+O`/`Cmd+S`). Tracks upstream via Git submodule. |
189
+
|[Markdown Desk](https://github.com/jhrepo/markdown-desk)| Native macOS wrapper built with [Tauri](https://tauri.app/), adding live reload and native file open/save. |
190
+
191
+
---
125
192
126
-
## 📄 License
193
+
## Contributing
127
194
128
-
This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.
195
+
Contributions are welcome! Please review the [Contributing Guide](https://github.com/ThisIs-Developer/Markdown-Viewer/wiki/Contributing) and open a pull request.
129
196
130
-
## 📈 Development Journey
197
+
---
198
+
199
+
## Contributors
200
+
201
+
Thanks to everyone who has contributed to Markdown Viewer.
131
202
132
-
The Markdown Viewer has undergone significant evolution since its inception. What started as a simple markdown parser has grown into a full-featured, professional application with multiple advanced capabilities. By comparing the [current version](https://markdownviewer.pages.dev/) with the [original version](https://a1b91221.markdownviewer.pages.dev/), you can see the remarkable progress in UI design, performance optimization, and feature implementation.
0 commit comments