Skip to content

Repository files navigation

md-reader

轻量 Markdown 阅读器 / 编辑器,基于 Tauri 2 + TypeScript + Milkdown Crepe。 观感对齐 Typora GitHub 主题,默认只读阅读模式,安装包约 4 MB。支持 Windows 和 macOS。

功能

  • 默认阅读模式,Ctrl+E 切换编辑,Ctrl+S 保存,Ctrl+O 打开(macOS 为
  • LaTeX 数学公式(KaTeX,只读时仅显示渲染结果)
  • 相对路径支持:./other.md 链接在阅读器内打开,相对路径图片正常显示
  • 导航历史:Alt+← / Alt+→ 或鼠标侧键前进后退
  • 文件被外部编辑器修改时自动热重载(有未保存修改时仅提示,不覆盖)
  • 拖拽打开、.md / .markdown 文件关联、未保存修改关闭确认

安装

Windows:安装包(推荐)

Releases 下载 md-reader_x.y.z_x64-setup.exe,双击安装:

  • 按用户安装(%LOCALAPPDATA%\md-reader),无需管理员权限
  • 自动注册 .md / .markdown 文件关联和开始菜单快捷方式
  • 升级直接运行新版安装包覆盖即可,无需先卸载

卸载:设置 → 应用 → md-reader → 卸载,或运行安装目录下的 uninstall.exe

macOS:DMG

Releases 下载 md-reader_x.y.z_aarch64.dmg(Apple Silicon) 或 md-reader_x.y.z_x64.dmg(Intel),打开后把 md-reader.app 拖入 Applications。

未经 Apple 签名/公证的构建首次打开会被 Gatekeeper 拦截 (提示"已损坏"或"无法验证开发者"),执行一次即可:

xattr -cr /Applications/md-reader.app

介意的话也可以从源码自行构建(见下)。

首次给 .md 设置默认打开方式:在任意 .md 文件上 右键 → 显示简介 → 打开方式 选 md-reader,点 全部更改

从源码构建

环境要求:

  • Node.js 18+
  • Rust(Windows 需 MSVC 工具链;macOS 需 Xcode Command Line Tools)
git clone <本仓库地址>
cd md-reader
npm install
npm run tauri build
# Windows 安装包: src-tauri/target/release/bundle/nsis/md-reader_x.y.z_x64-setup.exe
# Windows 免安装: src-tauri/target/release/md-reader.exe
# macOS:          src-tauri/target/release/bundle/dmg/md-reader_x.y.z_aarch64.dmg
#                 src-tauri/target/release/bundle/macos/md-reader.app

Windows 10/11 一般自带 WebView2 运行时,缺失时安装器会引导安装; macOS 使用系统 WKWebView,无额外运行时依赖。

开发

npm install
npm run tauri dev

License

MIT

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages