Haddock 转 RST转换器
所有处理都在你的设备上完成,大文件可能需要一点时间。
Haddock 是 Haskell 生态的文档标记:附着在函数上的 -- 注释块,渲染成每个 Hackage 包自带的 API 文档。把 RST 文档转成 Markdown/Word 给非 Sphinx 读者;或把 Markdown 内容作为 RST 导入 Sphinx 项目。
iLoveConverter 在你的电脑本地完成全部处理,因此既私密又快速:没有上传等待,不存储到任何服务器,也不限次数。想转多少文件都可以,批量转换开箱即用。
Haddock 与 RST 的对比
| Haddock | RST | |
|---|---|---|
| 数据结构 | 注释标记(--、'links'、@mono@) | 纯文本 + 指令 |
| 最适合 | Haskell API 文档 | 技术文档 |
如何将 Haddock 转换为 RST
- 1
选择文件
选择你的 Haddock 文件。
- 2
立即转换
文件先转换成 Markdown(保留标题、列表与段落的中间格式),再重建为目标格式。
- 3
下载结果
下载 RST——结构保留,复杂排版被简化。
关于 Haddock 格式
Haddock 是 Haskell 解释自己的方式:-- 注释块里的文档,用 '标识符链接'、@等宽@ 和 /斜体/ 标记,编译成 Hackage 上每个包都发布的 API 参考页。标记活在源码里,但格式自成一们小语言。
从源码注释里转出后,Haddock 文本变成普通结构化散文:Pandoc 把标题、代码块和标识符链接映射到 Markdown 或 HTML,API 知识得以进入手册、wiki 或静态站点生成器,无需重新打字。
+优点
- ✓文档与所描述的代码同处一地
- ✓跨 API 的标识符感知链接
- ✓整个 Haskell 生态的标准
!局限
- −只在 Haskell 项目里有意义
- −语法小,Haddock 之外输出器少
- −嵌在注释里——需先提取
关于 RST 格式
reStructuredText 是 Python 世界标准化的标记语言:Sphinx 用它构建整套文档站,PyPI 用它渲染项目介绍,docutils 等工具链围绕它建立。标题用标点下划线标出,.. image:: 和 .. code-block:: 之类的指令在不破坏纯文本可读性的前提下扩展能力。
RST 比 Markdown 更严格是有意为之——正是这种严格让大型文档树保持一致。把 RST 转成 Markdown 或 Word 能让 Sphinx 项目向全团队开放;把 Markdown 转回 RST 则能喂给 Sphinx 构建。
+优点
- ✓Sphinx/Python 文档的原生格式
- ✓大规模下依然一致:指令、角色、交叉引用
- ✓表格与提示框是一等语法
!局限
- −普及度不如 Markdown
- −更严格的规则有学习成本
- −部分指令绑定特定工具链
为什么把 Haddock 转换成 RST?
这个转换之所以存在,是有具体原因的:只在 Haskell 项目里有意义RST 则绕开了这一点——Sphinx/Python 文档的原生格式如果你正处在这种情况,用上面的工具几秒就能解决,全程都在你自己的设备上。
常见问题
Haddock 转 RST 真的免费吗?
完全免费,无需注册、无水印、也没有每日次数限制。网站依靠广告维持运营。
我的文件会被上传到服务器吗?
不会。转换通过 WebAssembly 完全在你的浏览器内完成,文件不会离开你的设备——这正是它既快又私密的原因。
Windows、Mac、iPhone、安卓都能用吗?
可以。任何装有现代浏览器的设备都适用:Windows、macOS、Linux、安卓和 iOS,无需安装任何软件。
Haddock 转 RST 有文件大小限制吗?
由于不上传,唯一的限制是你设备的内存。现代桌面浏览器处理几百 MB 的文件都没问题,超大文件只是需要稍等片刻。
转换出来的 RST 之后还能编辑吗?
取决于目标格式:RST 为自己的用途而生,本转换器忠实还原其内容,而不是凭空制造可编辑结构。需要大量再编辑时,请从面向编辑的格式入手,最后在这里导出终稿。
Haddock 文件的排版会完全保留吗?
本转换器会把 Haddock 的内容渲染成 RST,在目标格式允许的范围内尽量保持页面、比例与图片原样。下载前请用预览确认效果符合预期。