Markdown Reader

中文介绍

Markdown Reader 是一个免费、轻量、本地运行的 Markdown 阅读器和编辑器。它的目标很简单：像在 GitHub 上一样舒服地阅读 .md 文件，同时保留随时编辑、保存和导出 HTML 的能力。

项目体积极小，完整 Windows 安装包 zip 约 36 KB，不需要启动服务器，也不需要安装 Node.js、Python 或数据库。

项目亮点

• 免费使用：源码和安装包都可以直接使用。
• 体积极小：压缩安装包约 36 KB，适合直接通过微信、邮件、U 盘分发。
• 本地运行：纯 HTML / CSS / JavaScript，不依赖本地后端服务。
• GitHub 风格阅读体验：支持标题、表格、代码块、引用、列表、链接、图片等常见 Markdown 格式。
• 阅读/编辑双模式：双击 .md 默认进入阅读模式，点击 Edit 可切换到左右分栏编辑模式。
• 可设为默认打开程序：安装后可以让 .md / .markdown 文件默认用 Markdown Reader 打开。
• 一键无脑安装：解压后双击 Install_MarkdownReader.bat 即可安装到当前 Windows 用户。
• 联网翻译：Translate ZH 会调用 Google Translate 公开接口，把当前 Markdown 翻译为中文；代码块会保留不翻译。
• 自动临时 HTML 清理：作为 .md 默认打开程序时，会为当前文件生成临时 HTML，用独立浏览器窗口打开，窗口关闭后自动删除临时文件。

使用方式

方式一：下载安装包

1. 下载 release/MarkdownReader_Setup.zip
2. 解压 zip
3. 双击 Install_MarkdownReader.bat
4. 安装完成后，桌面会出现 Markdown Reader 快捷方式
5. 双击任意 .md 文件即可用 Markdown Reader 打开

如果 Windows 仍然保留旧默认程序，请右键任意 .md 文件，选择“打开方式”，再选择 Markdown Reader。

方式二：直接运行源码

进入 src 目录，双击：

MarkdownReader.cmd

或者直接打开：

index.html

卸载

在安装包解压目录中双击：

Uninstall_MarkdownReader.bat

目录结构

.
├─ src/                         # Source code
├─ release/                     # One-click installer and zip package
├─ docs/screenshot.png          # Screenshot
├─ README.md                    # Bilingual project introduction
└─ LICENSE

翻译说明

Translate ZH 使用 Google Translate 公开接口：

https://translate.googleapis.com/translate_a/single

该接口不需要 API Key，但可用性、限流和网络访问不做保证。如果网络受限，状态栏会显示 Translate failed。

---

English

Markdown Reader is a free, tiny, local Markdown reader and editor for Windows. It aims to make local .md files feel close to reading Markdown on GitHub, while still allowing quick editing, saving, downloading, and HTML export.

The full Windows setup zip is only about 36 KB. It does not require a local server, Node.js, Python, or a database.

Highlights

• Free to use: source code and installer are included.
• Tiny package: setup zip is about 36 KB.
• Local-first: plain HTML / CSS / JavaScript, no backend service required.
• GitHub-style rendering: headings, tables, code blocks, quotes, lists, links, and images.
• Read/Edit modes: opening a .md file starts in reader mode; click Edit for the split editor/preview layout.
• Default app support: can register itself as the default opener for .md and .markdown files.
• One-click Windows install: unzip and run Install_MarkdownReader.bat.
• Online translation: Translate ZH calls the public Google Translate endpoint and keeps code blocks untouched.
• Temporary HTML cleanup: when opening a .md file, the launcher creates a temporary HTML file, opens it in an app-style browser window, and deletes it after the window is closed.

Installation

1. Download release/MarkdownReader_Setup.zip
2. Extract it
3. Run Install_MarkdownReader.bat
4. Use the desktop shortcut or double-click a .md file

If Windows keeps another default Markdown app, right-click a .md file and choose Open with -> Markdown Reader.

Run From Source

Open the src folder and run:

MarkdownReader.cmd

Or open:

index.html

Uninstall

Run:

Uninstall_MarkdownReader.bat

License

MIT