Ronn создает man-страницы из Markdown-текста, генерируя стандартные файлы формата UNIX roff и автономную HTML-документацию.
Базовая структура документа Man (tool.1.ronn)
tool(1) -- краткое описание утилиты
======================================
## SYNOPSIS
`tool` [<options>] <files>...
## DESCRIPTION
**tool** обрабатывает файлы и выводит результаты в стандартный вывод.
## OPTIONS
* `-v`, `--verbose`:
Включить подробный вывод журнала (verbose).
* `-o` <file>, `--output`=<file>:
Указать путь к выходному файлу.
* `-h`, `--help`:
Показать окно справки.
## EXAMPLES
Запуск утилиты для всех файлов markdown:
$ tool -v *.md -o output.log
## SEE ALSO
man(1), ronn(7)
Команды компиляции (Compilation Commands)
# Конвертировать в стандартную man-страницу UNIX roff (tool.1)
ronn --roff tool.1.ronn
# Конвертировать в формат HTML (tool.1.html)
ronn --html tool.1.ronn
# Просмотр прямо в терминале без сохранения в файл
ronn --man tool.1.ronn