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:
Here is an example bin/ script to help you get started:
What is new?
Compatible changes:
- The
binman/rake_tasks
library has been renamed (with
deprecation) tobinman/rakefile
. The deprecation warning
will be removed in the next major release.
New features:
- Add
binman/gemspec
packaging convenience library which
automatically builds and includes your UNIX man page files
in your gem packages and also adds binman as a runtime and
development gem dependency.