iM

优雅的 macOS 文件阅读器。空格 Quick Look 预览，打开即只读阅读，外部改动实时刷新 — 语法高亮、暗色模式、数学公式、图表渲染。

---

支持的文件类型

类别	文件类型	扩展名
文档	Markdown	.md .markdown .mdown .mkd .mkdn .mdwn .mdtxt .mdtext
配置	YAML	.yaml .yml
配置	JSON	.json
配置	TOML	.toml
配置	XML / Plist	.xml .plist
配置	INI	.ini .cfg .conf
脚本	Shell	.sh .bash .zsh
脚本	Ruby	.rb .rbw
脚本	PHP	.php
脚本	Perl	.pl .pm
脚本	Lua	.lua
脚本	R	.r
Web	HTML	.html .htm
Web	CSS	.css
Web	SCSS	.scss
Web	JavaScript	.js
Web	TypeScript	.ts .tsx
Web	GraphQL	.graphql .gql
代码	Swift	.swift
代码	Python	.py
代码	C	.c .h
代码	C++	.cpp .cc .cxx .hpp
代码	Objective-C	.m
代码	Rust	.rs
代码	Go	.go
代码	Kotlin	.kt .kts
代码	SQL	.sql
其他	Diff/Patch	.diff .patch

特性

• 空格即预览 — Finder 选中文件按空格，无需打开任何应用
• 打开即阅读 — 独立窗口只读打开全部 28 种类型，与空格预览共用同一渲染引擎
• 实时刷新 — 外部编辑器保存即自动更新，保留滚动位置；兼容 VS Code/vim 原子保存
• 语法高亮 — highlight.js 提供高质量代码着色，亮暗模式自适应
• 数学公式 — KaTeX 行内和块级公式渲染
• 图表渲染 — Mermaid 流程图、时序图、类图等
• 安全净化 — DOMPurify 防止 XSS，自定义 URL scheme 路径遍历防护
• 大文件保护 — JSON 超过 2MB 自动截断提示
• 零操作 — 安装后无需任何设置，即装即用

安装

git clone https://github.com/xdfnet/iM.git
cd iM
make install

安装后首次打开 iM 会自动注册 Quick Look 扩展，此后 Finder 空格键即可预览。

使用

Quick Look 预览（默认）： Finder 选中文件按空格。

打开阅读：

• Finder 右键文件 →「打开方式」→ iM
• 终端：open -a iM 文件
• 已在应用内：⌘O 打开，或 File → Open Recent

阅读窗口严格只读。用其他编辑器修改并保存，窗口内容会实时刷新、保持滚动位置。关闭所有窗口即退出，不留后台进程。

构建

make build      # Debug 构建
make release    # Release 构建
make install    # Release 构建 + 安装到 /Applications/
make clean      # 清理构建产物

架构

iM.app（阅读器宿主；无文件启动注册扩展后自动退出）
├── AppDelegate.swift            — 入口：主菜单、打开事件、窗口生命周期
├── ReaderDocument.swift         — NSDocument 只读文档
├── ReaderWindowController.swift — 阅读窗口（WKWebView + 实时增量更新）
├── FileWatcher.swift            — DispatchSource 文件监听（兼容原子 rename）
├── FileContentRenderer.swift    — 28 类型分发（app / appex 共享）
├── PreviewHTML.swift            — 渲染引擎（Markdown → HTML）
├── EscapingHTMLFormatter.swift  — 安全 HTML 格式化
├── Frontmatter.swift            — YAML/TOML 元数据解析
├── AssetSchemeHandler.swift     — md-asset:// 本地资源加载
├── CodeFenceInfo.swift          — 代码块语言检测
├── Vendor/                      — 内联 JS 库
│   ├── KaTeX/  ├── Mermaid/  ├── Highlight/  └── DOMPurify/
└── PlugIns/quick-look.appex/    — Quick Look 扩展
    ├── PreviewProvider.swift     — 预览面板（调用 FileContentRenderer）
    └── InlineLocalAssets.swift   — 本地图片内联

新增文件类型

三处改动即可支持新类型（Quick Look 与阅读器同时生效）：

1. iM/Info.plist — 声明文件类型关联
2. quick-look/Info.plist — 注册 QL UTI
3. FileContentRenderer.swift — 在语言映射表加扩展名与 highlight.js 语言

致谢

基于 markdown-preview（pluk-inc）改造，继承了其原生 WKWebView 渲染管线与 Quick Look 扩展架构。

许可

MIT License。详见 LICENSE。