Closed noraj closed 11 months ago
Hello, can you assign this to me?
Hi @virajsazzala, yes, just tell me which method you plan to implement.
Yes, @noraj I've looked into it. I thought of using ronn to make the haiti.1
man page. It's simple and good!
I was wondering, if i should just create the man page or create and write a script to auto install it? something like a install.rb
file and add the script to haiti.gemspec
@virajsazzala You can provide the man page in the ronn markdown format and if you want to provide a rake task in https://github.com/noraj/haiti/blob/master/Rakefile to use ronn-ng to convert it to an actual man page and deploy it under man/haiti.1
.
@noraj Alright, then I'll make an actual man page -> haiti.1
, and deploy it under man/haiti.1
. I'll also write a rake task for this.
ronn is old, unmaintained and unreliable
I'm moving to asciidoc to generate man pages which is more powerful, robust, reliable and maintained.
generate a man page and ship it under
man/haiti.1
idea for man page in markdown then conversion to troff with pandoc
A better alternative would be to use
Ronnronn-nghttps://github.com/rtomayko/ronnhttps://spin.atomicobject.com/2015/05/06/man-pages-in-markdown-ronn/Also I can try cli2man to convert the help message into a manpage but I don't have to much hope.(dead for 9 years, still use python2) An newer alternative is https://github.com/Freed-Wu/help2man.A nicer alternative would be to use https://github.com/postmodern/kramdown-man
AsciiDoc to manpage