binman - UNIX man pages for Ruby bin/ scripts
https://github.com/sunaku/binman#readme
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
[Redcarpet2]: https://github.com/tanoku/redcarpet
What is new?
------------
New features:
* `BinMan.read()` now supports embedded document (=begin ... =end)
comments also. See binman(1) for the new, complete description
of leading comment headers.
Bug fixes:
* Ignore encoding comment line after shebang line.
* roff: fix first paragraphs inside list items.
Housekeeping:
* gemspec: build man page files before building gem.
* binman: raise error and suggest --help option.
* README: add link to example of binman markdown.
* README: add obligatory screen-shot! >:-)
--
A sinking ship gathers no moss.
-- Donald Kaul