Ronn builds man pages from Markdown text, generating standard UNIX roff format files and standalone HTML documentation.
Basic Man Document Structure (tool.1.ronn)
tool(1) -- concise description of tool
======================================
## SYNOPSIS
`tool` [<options>] <files>...
## DESCRIPTION
**tool** processes files and prints results to standard output.
## OPTIONS
* `-v`, `--verbose`:
Enable verbose log output.
* `-o` <file>, `--output`=<file>:
Specify destination output file.
* `-h`, `--help`:
Display help screen.
## EXAMPLES
Run tool over all markdown files:
$ tool -v *.md -o output.log
## SEE ALSO
man(1), ronn(7)
Compilation Commands
# Convert to standard UNIX roff man page (tool.1)
ronn --roff tool.1.ronn
# Convert to HTML format (tool.1.html)
ronn --html tool.1.ronn
# View in terminal directly without writing file
ronn --man tool.1.ronn