把 Markdown 文件拖进浏览器,渲染成一份能直接改的文档 —— 正文、标题、表格单元格点着就能编辑,公式双击改 TeX,Mermaid 图点右上角改源码。改完存回 .md,往返无损。
单文件 HTML,零依赖,不联网。
想要的东西其实很基础:把 .md 读得舒服一点,顺手改几个字和表格。为此买一个编辑器不太值,自己写一个又发现基础版真的不复杂 —— 于是就有了这个。
不打算做成 Typora 或 Obsidian 的替代品。脚注、图片管理、多文件工程都没有,真需要那些的时候该买还得买。
- Word 式的阅读版面 —— 纸张视图、自动目录(滚动高亮)、A4 打印排版
- 直接编辑 —— 正文、标题、表格单元格;表格行列增删;撤销/重做
- LaTeX 公式 —— 行内
$...$与块级$$...$$,MathJax SVG 渲染,双击改 TeX - Mermaid 图 ——
```mermaid代码块直接出图,可改源码 - ⌘S 写回原文件 —— Chrome/Edge 下直接改硬盘上那个
.md,不走下载文件夹 - 导出 ——
.md无损往返 / ⌘P 存 PDF / pandoc 转 docx(LaTeX 会变成 Word 原生公式对象) - 深浅色跟随系统
| 打开方式 | 一键 docx | 双击 .md 直接打开 |
|---|---|---|
双击 md-reader.html |
✗ | ✗ |
双击 启动服务.command(→ localhost:5473) |
✓ | ✓ |
| 部署到静态托管后访问 | ✗ | ✓ |
只有一份源码 md-reader.html,用什么方式打开决定了有什么功能。
一键 docx 需要本地跑一个小服务 —— 浏览器不能直接调 pandoc,所以由 md-server.js 代劳。它只监听 127.0.0.1,不对外。
双击 .md 直接打开 靠 PWA:装成应用后注册成 .md 的文件处理器。需要 HTTPS 或 localhost,所以 file:// 下用不了。
git clone https://github.com/della119/md-editor.git
cd md-editor
open md-reader.html # 只想读和改，到此为止想要一键导出 docx,先装 pandoc(官方下载,或 brew install pandoc),然后:
./启动服务.command # 或 node md-server.js./build-standalone.sh产出两样:
| 产物 | 用途 |
|---|---|
md-reader-单文件版.html |
约 5.5MB,库全部内联。直接发给别人,双击就用 |
deploy/ |
传静态托管(Netlify / Cloudflare Pages / …)。带 PWA,可安装、可离线 |
两者都是生成物,不进版本库。改功能改 md-reader.html,然后重新构建。
| 许可证 | 说明 | |
|---|---|---|
| MathJax | Apache-2.0 | 公式渲染,用 SVG 输出所以不需要字体文件 |
| Mermaid | MIT | 图表渲染 |
| pandoc | GPL-2.0+ | 可选。只有 docx 导出用得上,不打包在本仓库里 |
MathJax 和 Mermaid 以构建产物形式放在 lib/,方便离线使用。
脚注、HTML 内嵌块、图片上传管理、多文件工程。pandoc 也不认识 mermaid —— 转 docx 时图会变成代码块,要带图的成品请用 ⌘P 存 PDF。
日常操作、快捷键、部署步骤见 说明.md。
MIT