☰ 菜单
命令行 开源 5 次安装/月

ronn for Mac 版

ronn

构建手册——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 手册页,可作为替代方案。

如何安装 ronn

  1. 打开 终端(按 ⌘ + 空格,输入“终端”)。
  2. 如果还没安装 Homebrew,先运行下面这条安装命令。
  3. 运行下面这条命令:

最近 10 个版本记录

该项目暂未在 GitHub 发布 Release。

与同类应用对比

只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。

与同类应用对比
应用版本许可证架构近 30 天安装
ronn0.7.3MIT命令行5
spackv1.2.2Apache-2.0 OR MIT命令行14
go-md2manv2.0.7MIT命令行3,822
garblev0.18.0BSD-3-Clause命令行51

命令行工具中的类似应用

发表评论

评论表单加载中…