Haddock 转 AsciiDoc转换器
所有处理都在你的设备上完成,大文件可能需要一点时间。
Haddock 是 Haskell 生态的文档标记:附着在函数上的 -- 注释块,渲染成每个 Hackage 包自带的 API 文档。当文档需要进入 Word、Markdown 管线或 HTML 站点且不能丢结构时,转换 AsciiDoc。
由于整个转换都在你的设备上完成,它快速、无限量且真正私密——无需账号、没有水印、文件不会出现在任何服务器上。多个文件一次性转换。
Haddock 与 AsciiDoc 的对比
| Haddock | AsciiDoc | |
|---|---|---|
| 数据结构 | 注释标记(--、'links'、@mono@) | 纯文本标记(==、[source]、|===) |
| 类型与校验 | UTF-8 文本 | UTF-8 文本 |
| 兼容性 | Haskell、Hackage、Pandoc | Asciidoctor、Git 文档、Pandoc |
| 最适合 | Haskell API 文档 | 技术书与大型文档集 |
如何将 Haddock 转换为 AsciiDoc
- 1
选择文件
选择你的 Haddock 文件。
- 2
立即转换
文件先转换成 Markdown(保留标题、列表与段落的中间格式),再重建为目标格式。
- 3
下载结果
下载 AsciiDoc——结构保留,复杂排版被简化。
关于 Haddock 格式
Haddock 是 Haskell 解释自己的方式:-- 注释块里的文档,用 '标识符链接'、@等宽@ 和 /斜体/ 标记,编译成 Hackage 上每个包都发布的 API 参考页。标记活在源码里,但格式自成一们小语言。
从源码注释里转出后,Haddock 文本变成普通结构化散文:Pandoc 把标题、代码块和标识符链接映射到 Markdown 或 HTML,API 知识得以进入手册、wiki 或静态站点生成器,无需重新打字。
+优点
- ✓文档与所描述的代码同处一地
- ✓跨 API 的标识符感知链接
- ✓整个 Haskell 生态的标准
!局限
- −只在 Haskell 项目里有意义
- −语法小,Haddock 之外输出器少
- −嵌在注释里——需先提取
关于 AsciiDoc 格式
AsciiDoc 是轻量标记长大后的样子。Markdown 止步于粗体和列表,而 AsciiDoc 能承载扉页、多级章节、标注、警示、交叉引用和真正的表格语法——足以全程用纯文本写出整本技术书。Git 与 Linux 内核文档生态都以它为标准,通过 Asciidoctor 渲染。
这个格式的弱点是工具引力:Asciidoctor/Ruby 世界之外的 AsciiDoc 转换器很稀缺——这正是 Pandoc 补位的地方。转成 Word 可把书稿交到 Office 里的编辑手上;转成 Markdown 可接入现代文档站。章节结构与表格全程保留。
+优点
- ✓书籍级结构:章节、标注、警示、交叉引用
- ✓驱动 Git 与 Linux 内核文档——大规模实战检验
- ✓纯文本状态下依然可读
!局限
- −对随手笔记而言语法比 Markdown 重
- −转换器生态集中在 Asciidoctor 工具链
- −方言多(旧 asciidoc 与 asciidoctor)
为什么把 Haddock 转换成 AsciiDoc?
这个转换之所以存在,是有具体原因的:只在 Haskell 项目里有意义AsciiDoc 则绕开了这一点——书籍级结构:章节、标注、警示、交叉引用如果你正处在这种情况,用上面的工具几秒就能解决,全程都在你自己的设备上。
常见问题
Haddock 转 AsciiDoc 真的免费吗?
完全免费,无需注册、无水印、也没有每日次数限制。网站依靠广告维持运营。
我的文件会被上传到服务器吗?
不会。转换通过 WebAssembly 完全在你的浏览器内完成,文件不会离开你的设备——这正是它既快又私密的原因。
Windows、Mac、iPhone、安卓都能用吗?
可以。任何装有现代浏览器的设备都适用:Windows、macOS、Linux、安卓和 iOS,无需安装任何软件。
Haddock 转 AsciiDoc 有文件大小限制吗?
由于不上传,唯一的限制是你设备的内存。现代桌面浏览器处理几百 MB 的文件都没问题,超大文件只是需要稍等片刻。
转换出来的 AsciiDoc 之后还能编辑吗?
取决于目标格式:AsciiDoc 为自己的用途而生,本转换器忠实还原其内容,而不是凭空制造可编辑结构。需要大量再编辑时,请从面向编辑的格式入手,最后在这里导出终稿。
Haddock 文件的排版会完全保留吗?
本转换器会把 Haddock 的内容渲染成 AsciiDoc,在目标格式允许的范围内尽量保持页面、比例与图片原样。下载前请用预览确认效果符合预期。