在20XX年撰写手册

时间:2018-08-20 22:22:54

标签: unix man

我写了一个程序,我想为此写一个手册页。

我开始学习Groff,我真的觉得这很糟糕。 man宏难以理解,难以使用,并且是生产力的真正障碍。 mdoc宏添加了一个不错的“语义”扩展名,但是它们仍然受到限制,这使其难以置信。生成的“代码”的可维护性很差。

当然我知道我可以通过pandoc将任何现代标记语言(例如Markdown)转换为联机帮助页,但是我不喜欢这种结果,我也不喜欢将pandoc添加为对反正我的项目。

有没有办法从合理的标记语言中获得体面的联机帮助页?

2 个答案:

答案 0 :(得分:1)

我为我编写的bash和ruby脚本编写了联机帮助页。

我将它们格式化为markdown,这是一种流行且简单的文本格式。

然后,我使用一个名为ronn的红宝石来使用man宏将markdown处理为groff格式。 Ronn还可以从相同的markdown来源输出html。

答案 1 :(得分:1)

在这里OP。在检查了一些替代方案之后,我决定选择Asciidoc。

确实有很多选择。例如,选中this other question

我还意识到,鉴于可以使用许多工具的事实,这个问题没有很好的答案,最终这只是一个问题:) 我将投票赞成结束我自己的问题(如果有任何问题,将留作参考)。