Haddock 转 Org转换器
所有处理都在你的设备上完成,大文件可能需要一点时间。
Haddock Documentation与Emacs Org mode的定位并不相同:Haddock 是 Haskell 生态的文档标记:附着在函数上的 -- 注释块,渲染成每个 Hackage 包自带的 API 文档。把 Org 笔记转成 Markdown、Word 或 EPUB 分给非 Emacs 协作者;或把 Markdown 内容导入你的 Org 工作流。
由于整个转换都在你的设备上完成,它快速、无限量且真正私密——无需账号、没有水印、文件不会出现在任何服务器上。多个文件一次性转换。
Haddock 与 Org 的对比
| Haddock | Org | |
|---|---|---|
| 数据结构 | 注释标记(--、'links'、@mono@) | 纯文本 + 关键字 |
| 最适合 | Haskell API 文档 | 笔记、规划、文学编程文档 |
如何将 Haddock 转换为 Org
- 1
选择文件
选择你的 Haddock 文件。
- 2
立即转换
文件先转换成 Markdown(保留标题、列表与段落的中间格式),再重建为目标格式。
- 3
下载结果
下载 Org——结构保留,复杂排版被简化。
关于 Haddock 格式
Haddock 是 Haskell 解释自己的方式:-- 注释块里的文档,用 '标识符链接'、@等宽@ 和 /斜体/ 标记,编译成 Hackage 上每个包都发布的 API 参考页。标记活在源码里,但格式自成一们小语言。
从源码注释里转出后,Haddock 文本变成普通结构化散文:Pandoc 把标题、代码块和标识符链接映射到 Markdown 或 HTML,API 知识得以进入手册、wiki 或静态站点生成器,无需重新打字。
+优点
- ✓文档与所描述的代码同处一地
- ✓跨 API 的标识符感知链接
- ✓整个 Haskell 生态的标准
!局限
- −只在 Haskell 项目里有意义
- −语法小,Haddock 之外输出器少
- −嵌在注释里——需先提取
关于 Org 格式
Org mode 是 Emacs 世界对「如果一切都是纯文本会怎样」的回答:一个 .org 文件装下你的大纲、带议程的 TODO、截止日期、表格甚至可运行的代码块。二十年的个人知识管理工作流都建立在它的星号加关键字语法上。
它过去的问题是在 Emacs 之外不好用——现在转换器就是那座桥:协作者拿 .md,领导拿 .docx,读者拿 .epub,LaTeX 期刊拿 .tex,大纲层级原样保留。把 Markdown 带回 Org 也只是一次点击。
+优点
- ✓大纲、TODO 与日程在一个文本文件里
- ✓面向未来:任何编辑器永远可读
- ✓Babel 代码块让文档可执行
!局限
- −完整功能依赖 Emacs 本体
- −对主流协作者而言语法陌生
- −缺少原生的移动端编辑方案
为什么把 Haddock 转换成 Org?
转换的意义在于 Org 的长处正好补上 Haddock 给不了的东西:大纲、TODO 与日程在一个文本文件里而另一边,只在 Haskell 项目里有意义用上面的转换器过一遍,你的文件就站到了正确的取舍那边。
常见问题
Haddock 转 Org 真的免费吗?
完全免费,无需注册、无水印、也没有每日次数限制。网站依靠广告维持运营。
我的文件会被上传到服务器吗?
不会。转换通过 WebAssembly 完全在你的浏览器内完成,文件不会离开你的设备——这正是它既快又私密的原因。
Windows、Mac、iPhone、安卓都能用吗?
可以。任何装有现代浏览器的设备都适用:Windows、macOS、Linux、安卓和 iOS,无需安装任何软件。
Haddock 转 Org 有文件大小限制吗?
由于不上传,唯一的限制是你设备的内存。现代桌面浏览器处理几百 MB 的文件都没问题,超大文件只是需要稍等片刻。
Haddock 文件的排版会完全保留吗?
本转换器会把 Haddock 的内容渲染成 Org,在目标格式允许的范围内尽量保持页面、比例与图片原样。下载前请用预览确认效果符合预期。
转换出来的 Org 之后还能编辑吗?
取决于目标格式:Org 为自己的用途而生,本转换器忠实还原其内容,而不是凭空制造可编辑结构。需要大量再编辑时,请从面向编辑的格式入手,最后在这里导出终稿。