md-reader

NeiloooMIT活跃维护

轻量快速的 Windows Markdown 阅读器,基于 Tauri 2 + Vue 3 构建,安装包仅 5MB,支持 KaTeX 公式、Mermaid 图表、代码高亮、全文搜索和所见即所得 PDF 导出。

一个轻量快速的 Markdown 阅读器 / Markdown viewer & reader for Windows. Tauri 2 + Vue 3, 5MB, supports KaTeX math, Mermaid diagrams, syntax highlighting, full-text search, and WYSIWYG PDF export via Edge

v0.3.13发布于 2026-11-02 05:16 UTC219star +2 / 7 天29fork同步于 2026-11-10 06:06 UTC

怎么上手

从 README 代码块原样提取,可能是其中一种安装方式
winget install --id JohnMacFarlane.Pandoc -e
pnpm install
pnpm tauri dev
pnpm tauri build
硬件要求

README 没有说明硬件要求。

下载:源码 zip·GitHub Releases(安装包)本站不镜像安装包

项目说明

这个项目的说明还在生成中,先参考下面「最近发版」和 README。

最近发版

5 个版本v0.3.13
  1. v0.3.13MD Reader v0.3.13最新正式版2026-11-02 · 2026-11-02 05:16 UTC

    新增

    • 编辑模式格式化工具栏:标题级别(正文 / H1~H6)、加粗 / 斜体 / 下划线 / 高亮 / 行内代码、无序 / 有序列表、引用、代码块、分割线。支持多行选区、同级别再选取消、有序列表自动编号,操作可用 Ctrl+Z 撤销;按钮悬停显示对应快捷键。可在「设置 → 阅读 → 编辑工具栏」开启或关闭(默认开启)。
    • 快捷键支持单条停用与全部关闭:快捷键面板每行新增「停用 / 启用」,底部新增「全部关闭 / 全部启用」。停用后按键不再响应并回落到默认行为,状态持久化;「全部重置」会恢复默认绑定并重新启用。

    修复

    • 修复编辑模式下大纲无法高亮、点击无法定位的问题:标题新增源码行号,编辑器滚动实时上报顶部可见行并映射高亮,点击目录条目直接跳转到对应源码行。

    下载说明

    • Windows:下载 .msi 安装版,或 .exe 绿色版(浏览器拦截 exe 时可右键保留)。
    • 若系统提示缺少 WebView2,可在 v0.3.12 发布页下载 MicrosoftEdgeWebView2RuntimeInstallerX64.exe 补装,或访问微软官方下载页。
  2. v0.3.12MD Reader v0.3.122026-10-10 · 2026-10-10 06:41 UTC
    查看更新说明

    新增

    • 设置新增「启动时恢复标签页」开关(#38):阅读设置中可开/关,默认开启。关闭后重启不再自动重开上次的全部标签,直接进入空白欢迎页;双击文件启动、拖放打开不受影响。标签记录不会被删除,重新打开开关即恢复原行为。

    下载说明

    • Windows:下载 .msi 安装版,或 .exe 绿色版(浏览器拦截 exe 时可右键保留)。
    • 提示 WebView2 缺失时:下载并安装 MicrosoftEdgeWebView2RuntimeInstallerX64.exe(微软官方离线安装包),装好后绿色版即可运行,无需联网。系统要求 Windows 10 1803(2018 年 4 月)及以上。
  3. v0.3.11MD Reader v0.3.112026-09-29 · 2026-09-29 03:46 UTC
    查看更新说明

    修复

    • 修复 PNG 长图导出时代码块、宽表格等带滚动区域被截断的问题(#37):长代码行现在在图内自动换行(图宽保持阅读宽度),无法换行的宽表格 / 公式 / Mermaid 图则把整张图加宽到实际内容宽度完整展开。
    • 修复本地文档链接两类失效(#36):① WSL UNC 路径(\wsl.localhost\...)文档内的相对链接报「系统找不到指定的路径」;② Windows 盘符绝对路径链接(D:/docs/x.md)点击无反应。两类问题涉及的相对路径图片也一并修好。

    下载说明

    • Windows:下载 .msi 安装版,或 .exe 绿色版(浏览器拦截 exe 时可右键保留)。
  4. v0.3.10MD Reader v0.3.102026-09-18 · 2026-09-18 04:42 UTC
    查看更新说明

    新增

    • 数学公式新增 \( ... \) 行内与 \[ ... \] 块级 LaTeX 分隔符支持(#34)。AI 生成文档(ChatGPT / Claude 等)与学术文档常见的这两种公式写法现在可直接渲染,无需手动替换为 $ / $$。

    下载说明

    • Windows:下载 .msi 安装版,或 .exe / .zip 绿色版(浏览器拦截 exe 时请下载 zip)。
    • macOS / Linux:实验版,未签名;macOS 首次打开可右键打开,Linux AppImage 需先 chmod +x。
  5. v0.3.9MD Reader v0.3.92026-09-14 · 2026-09-14 06:38 UTC
    查看更新说明

    修复

    • 修复 macOS 上双击 .md 文件导致应用立即闪退的问题(v0.3.8 引入,#33)。macOS 的文件投递事件在应用初始化早期到达,此前会触发 panic 导致闪退;现已修复并在真实 macOS 环境验证双击打开正常。

    下载说明

    • Windows:下载 .msi 安装版,或 .exe / .zip 绿色版(浏览器拦截 exe 时请下载 zip)。
    • macOS / Linux:实验版,未签名;macOS 首次打开可右键打开,Linux AppImage 需先 chmod +x。

用户点评

登录用户的真实使用记录,可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译

    MD Reader

    English | 简体中文

    Release License Downloads Platform

    一个轻量、快速、所见即所得的 Markdown 桌面阅读器与编辑器,基于 Tauri 2 + Vue 3 + Rust 构建。

    体积小(约 6 MB),启动快,支持多标签页、源码编辑、公式、图表、代码高亮、文件树、全文搜索、PDF/HTML/DOCX/PNG 导出。

    📦 下载最新版本


    主要特性

    多标签页

    • 同时打开多个 Markdown 文件,工具栏下方水平标签栏切换
    • 点击切换、中键关闭,再次打开已打开的文件会聚焦到对应标签而非重复打开
    • 每个标签独立保留内容、未保存草稿、编辑/预览模式、大纲和滚动位置,切换即恢复现场
    • 标签页右键菜单:关闭 / 关闭其他标签 / 关闭全部、刷新、复制文件路径、打开文件所在文件夹
    • 应用重启后自动恢复上次打开的标签列表与激活项

    阅读

    • CommonMark + GitHub Flavored Markdown
    • YAML Front Matter 解析与预览:顶部 --- 元数据渲染为信息卡片,正文和大纲自动剥离元数据
    • 代码语法高亮(highlight.js,30+ 语言)
    • 数学公式(KaTeX,按需加载)
    • Mermaid 图表 20+ 种(流程图、时序图、甘特图、类图、状态图、思维导图、饼图等,按需加载,SVG 经 DOM 解析清洗,仅剥除脚本与事件属性)
    • 任务列表 / 脚注 / Emoji / 标题锚点
    • 亮 / 暗主题切换,记忆主题偏好

    编辑

    • CodeMirror 源码编辑模式,支持 Markdown 高亮、行号、折叠、括号匹配、查找/替换、跳转行
    • 预览 / 编辑一键切换(Ctrl+E),切换时按源码行同步视口位置
    • Markdown 格式化快捷键:Ctrl+B 加粗、Ctrl+I 斜体、Ctrl+U 下划线、Ctrl+L 高亮、Ctrl+Shift+` 行内代码
    • 编辑模式下 Ctrl+V 粘贴图片,自动保存到当前文件同目录 images/ 并插入 Markdown 链接
    • 手动保存 / 另存为,切换文件、关闭标签、关闭窗口和外部变更时保护未保存修改

    导航

    • 左侧文件树,递归扫描文件夹
    • 大纲(TOC)滚动同步高亮,支持分级展开折叠(▶/▼ 箭头 + 全部展开/折叠按钮,全部折叠显示到二级标题)
    • 大纲位置可在设置中切换:左侧(侧栏 tab,工具栏大纲按钮隐藏)/ 右侧(独立面板),默认右侧
    • 三栏可拖拽分隔条,独立显隐
    • 内部链接 [文本](https://github.com/Neilooo/md-reader/blob/HEAD/other.md#锚点) 跳转
    • 图片相对路径自动解析

    查找

    • Ctrl+F 当前文档查找(高亮、上一/下一)
    • Ctrl+Shift+F 跨文件全文搜索(Rust 后端高速)

    导出

    • PDF(Edge headless,1-3 秒,所见即所得,无 LaTeX;24 套预设模板 + 字体 / 颜色 / 间距密度 / 页面样式可调,设置内实时预览,详见下方「PDF 导出样式」)
    • PNG 长图(整篇渲染为一张所见即所得的长图,含公式 / 图表 / 代码高亮 / 表格;默认 2 倍缩放,超长文档自动适配画布上限)
    • HTML(自包含单文件,图片/CSS 全部内嵌)
    • DOCX(pandoc 路线,需安装 pandoc;可设置 Word 模板 .docx 通过 --reference-doc 控制字体、标题和段落样式)

    体验

    • 阅读设置:字号、编辑器字号、行高、宽度、字体、大纲位置可调
    • 阅读区背景颜色:亮 / 暗主题分别自定义,支持预设色板与一键恢复默认
    • 快捷键自定义:设置 -> 查看快捷键,点击键帽录制新组合,支持全局和编辑器快捷键、冲突检测、逐项/全部重置
    • 文件变更监听,自动刷新
    • 最近文件 + 滚动位置记忆;空状态展示最近文件列表,点击直接打开
    • 文件关联:.md / .markdown / .mdx 双击直接打开;设置页可一键注册当前用户级文件关联(绿色版也可用)
    • 单例运行:从资源管理器多次打开会复用窗口
    • 拖拽文件到窗口直接打开
    • 界面语言切换:简体中文 / English
    • 检查更新:设置页可查看当前版本并对比 GitHub Releases 最新版,发现新版本可一键打开下载页

    快捷键

    键动作
    Ctrl+E切换预览 / 编辑模式
    Ctrl+B加粗(编辑模式)
    Ctrl+I斜体(编辑模式)
    Ctrl+U下划线(编辑模式)
    Ctrl+L高亮(编辑模式)
    Ctrl+Shift+`行内代码(编辑模式)
    Ctrl+F当前文档查找;编辑模式下打开编辑器查找
    Ctrl+H编辑模式下替换
    Ctrl+G编辑模式下跳转行
    Ctrl+Shift+F全文搜索
    Ctrl+N新建 Markdown 文件
    Ctrl+O打开文件
    Ctrl+W关闭当前标签
    Ctrl+Tab下一个标签
    Ctrl+Shift+Tab上一个标签
    Ctrl+→向右切换标签
    Ctrl+←向左切换标签
    Ctrl+,阅读设置
    Ctrl+S保存当前文件
    Ctrl+Shift+S另存为
    Ctrl+P系统打印 / 另存为 PDF
    Ctrl+=放大字体(编辑模式调编辑器字号,预览模式调阅读字号)
    Ctrl+-缩小字体(同上)
    Ctrl+0重置字体为默认(编辑器 14px,阅读 16px)
    Ctrl+滚轮放大/缩小字体(同 Ctrl+=/-,两模式分流)
    Esc关闭查找 / 设置 / 弹窗

    以上快捷键均可在「设置 -> 查看快捷键」中自定义(Esc 和滚轮缩放除外)。

    界面展示

    image-20260701093258687

    image-20260701093345426

    PDF 导出样式设置

    安装

    Windows(正式版)

    从 Releases 页面 下载:

    文件说明
    MD-Reader-*-windows-x64-setup.msi安装版:双击安装,自动注册 .md / .markdown / .mdx 文件关联
    MD-Reader-*-windows-x64-portable.exe绿色版:解压即用,不写注册表
    MD-Reader-*-windows-x64-portable.zip绿色版压缩包:解压后运行,避免浏览器拦截 exe 下载

    Windows 10 / 11 自带 WebView2 Runtime,无需额外安装。旧版 Windows 10 可能需要从 Microsoft 官网 单独安装 WebView2 Runtime。

    macOS / Linux(实验版)

    macOS 和 Linux 构建目前为实验性,由 GitHub Actions 在发布 tag 时自动构建并附加到 Releases 页面,未做代码签名:

    • macOS:下载 .dmg 或 .app.tar.gz
    • Linux:下载 .AppImage / .deb / .rpm

    实验版未签名:macOS 首次打开需右键 → 打开,或执行 xattr -dr com.apple.quarantine "MD Reader.app";Linux AppImage 需先 chmod +x。

    使用前需要安装的外部工具

    核心阅读和编辑功能完全不需要安装任何东西。可选功能按需安装:

    功能依赖Win10/11 默认安装方法
    阅读 / 编辑 / 多标签 / 文件树 / 全文搜索 / 公式 / 图表 / HTML / PNG 导出无—无需安装
    PDF 导出(所见即所得)Microsoft Edge(Chromium)/ Chrome✅ 自带通常已自带;如缺失从 microsoft.com/edge 下载
    DOCX 导出pandoc ≥ 2.x❌见下方
    打印系统打印✅ 自带无需安装

    安装 pandoc(仅 DOCX 导出需要)

    winget install --id JohnMacFarlane.Pandoc -e
    

    或从 pandoc.org/installing.html 下载安装包。安装完成后需要重启 MD Reader。

    如果你只需要 PDF / HTML 导出,不需要安装 pandoc。

    开发

    环境要求

    工具版本安装
    Node.js≥ 18https://nodejs.org/
    pnpm≥ 8npm install -g pnpm
    Rust≥ 1.77https://rustup.rs/
    WebView2 Runtime—Win10/11 自带
    Visual Studio Build Tools2019+含 "Desktop development with C++" 工作负载

    命令

    pnpm install
    pnpm tauri dev
    pnpm tauri build
    pnpm lint
    pnpm format
    

    技术栈

    • 桌面框架: Tauri 2(Rust + WebView2)
    • 前端: Vue 3 + TypeScript + Vite
    • Markdown: markdown-it + 多个插件
    • 编辑器: CodeMirror 6
    • 公式: KaTeX
    • 图表: Mermaid
    • 代码高亮: highlight.js
    • PDF 导出: 系统 Edge --headless=new --print-to-pdf
    • DOCX 导出: pandoc
    • 文件监听: notify + notify-debouncer-mini
    • 全文搜索: walkdir + 流式逐行扫描
    • 单例运行 / 文件关联: tauri-plugin-single-instance
    • 国际化: vue-i18n

    PDF 导出样式

    设置 →「PDF 导出」标签页(与阅读设置相互独立),导出 PDF / 打印时套用:

    • 24 套预设模板,下拉按组浏览:
      • 文档:现代(默认)/ 简约 / 学术 / 护眼 / 商务蓝 / 古典棕 / GitHub 风格
      • 开发:暗色 / 终端绿 / Dracula 紫 / VS Code 蓝 / Nord 极光 / Solarized 浅色 / Solarized 深色 / Gruvbox 浅色 / Gruvbox 深色 / Monokai / Catppuccin / One Dark
      • 创意:樱花粉 / 薰衣草紫 / 海洋青 / 日落橙 / 森林苔藓
    • 间距密度:紧凑 / 标准 / 宽松
    • 字体:正文 / 标题 / 代码字体,正文字号、行高
    • 颜色:文字、标题、链接、代码背景、页面背景等可自定义
    • 页面:A4 / Letter,纵向 / 横向,页边距
    • 实时预览:示例文本可编辑、即改即见,支持浅色 / 深色双栏对照

    PDF 导出原理

    不依赖 LaTeX 或额外的渲染引擎。

    1. 前端把已渲染的 DOM(KaTeX 公式、Mermaid SVG 已就绪)抓取
    2. 图片转 base64 内嵌、KaTeX/highlight.js CSS 内嵌
    3. Rust 写临时 HTML 到 %TEMP%(ASCII 路径)
    4. 调用系统 Edge headless 模式:--headless=new --print-to-pdf=...
    5. Edge 完成后把 PDF 拷贝到用户选择的目标路径

    结果:1-3 秒生成,与阅读器视觉完全一致。

    常见问题

    Q: 启动应用提示缺失 WebView2?

    A: 从 https://developer.microsoft.com/microsoft-edge/webview2/ 下载 Evergreen Bootstrapper 安装一次即可。Win10 21H2 及以上、Win11 默认自带。

    Q: 导出 PDF 时找不到 Edge?

    A: 应用会弹文件选择对话框让你指定 msedge.exe 路径。也可以选择 Chrome(chrome.exe),同样工作。

    Q: 导出 DOCX 提示未检测到 pandoc?

    A: 安装 pandoc 后重启 MD Reader。

    Q: 支持 macOS / Linux 吗?

    A: 支持,但目前为实验版本。正式发布的是 Windows 版;macOS / Linux 可通过 GitHub Actions 自行构建(见上方「安装」)。这些实验版未做代码签名。

    许可

    MIT