Skip to content

Latest commit

 

History

13 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MadReader

给 Mac 的精简 Markdown 阅读器。打开一个目录 → 左边树状结构 → 点击即读 → 尽可能快。

特点

  • 📂 一键打开目录 — 选一个文件夹或把文件夹拖到 Dock 图标上,左侧自动生成 Markdown 文件树。
  • 🌳 树状导航 — 懒加载、后台扫描,只看 .md / .markdown,几万个文件也不卡。
  • 秒开渲染 — WKWebView + 本地 marked.js / highlight.js,无网络依赖。
  • 🎨 精致排版 — 优秀的 CSS 排版,跟随系统暗色模式。
  • 🪶 极简原生 — Swift + SwiftUI,无沙盒、无依赖、内存占用极低。
  • ⌨️ 键盘友好 — ↑↓ 切换文件、⌘F 页内查找。

构建

需要 macOS 14+(Apple Silicon)。不需要完整 Xcode,只要有 Command Line Tools 即可用 swiftc 直接编译:

make run     # 编译 → 打开 app
make dmg     # 打包成可分发的 .dmg
make clean   # 清理

若安装了 XcodeGenbrew install xcodegen),可用 make gen 生成可在 Xcode 里打开的工程(可选)。

注:当前环境用 swiftc 直编到 .app bundle,绕过了 xcodebuild(无需完整 Xcode)。Assets.car 资源编译(AppIcon/AccentColor)需要 Xcode 的 actool,缺失时会自动跳过,不影响应用运行。

项目结构

mad-reader/
├── archive/susu-legacy/   # 旧项目归档(保留历史)
├── MadReader/             # 新项目源码
│   ├── App/               # @main 入口、全局状态
│   ├── Models/            # 文件树模型、最近目录持久化
│   ├── Features/
│   │   ├── Sidebar/       # 目录树
│   │   └── Reader/        # WKWebView 渲染 + CSS
│   └── Resources/         # marked.js / highlight.js / page.css
├── project.yml            # XcodeGen 配置
└── Makefile               # build / run / dmg

License

MIT

About

Susu - Handy Doc Apps for Programmers.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages