binman - UNIX man pages for Ruby bin/ scripts
GitHub - sunaku/binman: 🤓 Creates manual pages from header comments
What is it?
binman produces UNIX man pages for your Ruby bin/
scripts using
markdown(7), roff(7), Redcarpet2 for conversion thereof, and man(1).
Here is an obligatory screen-shot of binman in action:
http://ompldr.org/vYXNlNg
Here is an example bin/ script to help you get started:
https://raw.github.com/sunaku/binman/master/bin/binman
What is new?
Housekeeping:
-
Extracted
BinMan::Renderer
into redcarpet-manpage library. -
The Redcarpet2 library is not a runtime gem dependency anymore.
-
Forgot to introduce leading comment headers in binman(1) man page.