search

lakruzz / gh-phlow

This repository is a template for our default Github issues developer workflow in Praqma
3 stars 2 forks source link

Figure out how to generate a manpage #24

Closed groenborg closed 7 years ago

groenborg commented 7 years ago

Create a synopsis

groenborg commented 7 years ago

After some research I have found out that man pages a written in a syntax called Groff, and are typically located in, depending on the operating system and application, /usr/share/man. A tool called ronn can be used to generate these pages!

groenborg commented 7 years ago

Seem there are an extension where you can write your man page in markdown and then convert it. I will try out the extension, using that will be simpler, since we have one less syntax to worry about, and markdown is easier to read that roff/groff

groenborg commented 7 years ago

a sidenote.. git-lfs uses Ronn as well!

groenborg commented 7 years ago

Ronn creates awesome man pages from markdown syntax.. VERY helpful. There is also an option to export it to an html page, so it can be hosted by GitHub pages. I have added an example under go-snippits