ronn for Mac 版
构建手册——roff 的相反
ronn 是什么
Ronn 是一个把纯文本转成手册页的工具。它读取用 Markdown 写成的 `.ronn` 文件,输出两种结果:供终端显示的 roff 格式,以及供网页使用的 HTML。源格式保留了 Markdown 的全部语法,但结构更严格,并针对手册页常见需求做了扩展,比如定义列表和链接写法,具体规范由 ronn-format(7) 手册页说明。
它解决的问题很直接:手写 roff 麻烦且难维护,而直接用 Markdown 又缺少手册页所需的结构约束。Ronn 让人用熟悉的 Markdown 写文档,同时生成符合 man 系统习惯的输出。除了分别构建 roff 和 HTML,它还支持只生成独立 HTML、批量处理目录下的文件,以及不落盘直接把 ronn 文件当手册页预览。
适合谁?主要是需要为命令行工具、库或格式编写手册页的开发者。项目作者也坦言,手册页结构固定、开门见山、排版克制,这些看似局限的特点恰恰是优点。如果你认同这种文档风格,又不想被 roff 语法拖累,ronn 是个顺手的选择。当然,原文也提到 pandoc 同样能把 Markdown 转成 roff 手册页,可作为替代方案。
它解决的问题很直接:手写 roff 麻烦且难维护,而直接用 Markdown 又缺少手册页所需的结构约束。Ronn 让人用熟悉的 Markdown 写文档,同时生成符合 man 系统习惯的输出。除了分别构建 roff 和 HTML,它还支持只生成独立 HTML、批量处理目录下的文件,以及不落盘直接把 ronn 文件当手册页预览。
适合谁?主要是需要为命令行工具、库或格式编写手册页的开发者。项目作者也坦言,手册页结构固定、开门见山、排版克制,这些看似局限的特点恰恰是优点。如果你认同这种文档风格,又不想被 roff 语法拖累,ronn 是个顺手的选择。当然,原文也提到 pandoc 同样能把 Markdown 转成 roff 手册页,可作为替代方案。
如何安装 ronn
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
该项目暂未在 GitHub 发布 Release。
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| ronn | 0.7.3 | MIT | 命令行 | 5 |
| spack | v1.2.2 | Apache-2.0 OR MIT | 命令行 | 14 |
| go-md2man | v2.0.7 | MIT | 命令行 | 3,822 |
| garble | v0.18.0 | BSD-3-Clause | 命令行 | 51 |
命令行工具中的类似应用
spack
Spack 是一个跨平台的包管理器,用于构建和安装同一软件的多个版本与配置。它支持 Linux、macOS、Windows 以及众多超级计算机环境。go-md2man
go-md2man 是一个把 Markdown 转换成 roff 格式(即 man 手册页)的命令行工具,借助 blackfriday 解析 Markdow…garble
garble 是一个通过包装 Go 工具链来混淆 Go 代码的工具,需要 Go 1.27 或更高版本。gradle-profiler
Gradle Profiler 是一款用于自动化收集 Gradle 构建性能分析与基准测试数据的工具。openssl@4
OpenSSL 是一套开源、商用级、功能完整的加密工具箱,主要服务于 TLS(早期称 SSL)、DTLS 和 QUIC 协议。xz
XZ Utils 是一个通用数据压缩库,同时附带命令行工具。它的原生格式是 .xz,也兼容旧的 .lzma 格式。所属分类:命令行工具