MdReader - Professional Markdown Reader & Converter

MdReader is a lightweight Markdown reader and editor built for Windows users. It features a sleek, modern UI and solves the biggest pain point for Markdown users — perfectly formatting content for pasting into Microsoft Word.

Built with the Wails (Go + WebView2) framework, it's lightweight yet powerful.

No more struggling with Markdown-to-Word formatting issues.

• One-click copy: Click the toolbar button to automatically render Markdown into rich text with inline styles.
• Publication-ready formatting: Built-in, carefully tuned CSS styles (serif fonts, proper line heights and paragraph spacing) — paste into Word and it's ready to use as a document or paper draft.

• Opens long documents in seconds: Deeply optimized for documents with tens of thousands of words.
• Smooth loading: Uses chunked async rendering technology — open large files with instant response, remaining content loads silently in the background, no UI freeze.
• Anti-white-screen mechanism: Built-in global error boundary capture and retry mechanism, gracefully handles various problematic code blocks.

• Right-click menu: Supports adding to the Windows context menu, right-click any .md file to open it instantly.
• Multi-tab: Supports opening multiple documents simultaneously, with independent state management across tabs.
• State persistence: Editor scroll position and cursor position are perfectly preserved when switching tabs (using Z-Index stacking technique).

• Immersive reading: Standard rendering based on GitHub Flavored Markdown with syntax highlighting.
• Efficient editing: Integrated CodeMirror editor with real-time editing and saving support.
• Batch open: Select and open multiple Markdown files at once via the file dialog.

• Backend: Go (Wails v2 framework) — handles system interaction, file I/O, and registry operations.
• Frontend: React + TypeScript + Vite — handles UI interactions.
• Styling: TailwindCSS — modern responsive layout.
• Editor: @uiw/react-codemirror.
• Rendering: react-markdown + rehype-highlight (automatically ignores unsupported language tags).

If you want to build this project locally:

• Go 1.18+
• Node.js 16+
• Wails CLI (go install github.com/wailsapp/wails/v2/cmd/wails@latest)

1. Clone the repository

   git clone https://github.com/wangbao0754/MdReader.git
   cd MdReader

2. Install dependencies

   # Frontend dependencies are installed automatically, but you can also run manually
   cd frontend && npm install

3. Run in development mode

   wails dev

4. Build for production (Windows)

   wails build -clean

   After the build completes, the executable will be located at build/bin/MdReader.exe.

Feel free to submit Issues or Pull Requests to improve this project! Whether it's fixing bugs or adding new features, your contributions are greatly appreciated.

This project is licensed under the MIT License.