Ronn
A tool that converts human-readable text files to roff for terminal manpages and HTML for web display.
What is Ronn?
Ronn is a tool that builds UNIX manual pages by converting simple, human-readable text files to roff format for terminal display and HTML for web publishing. It extends Markdown with syntax for manpage-specific features like definition lists and link notation, providing a modern workflow for creating traditional documentation.
Developers and technical writers who need to create and maintain UNIX manual pages for command-line tools, libraries, or formats.
Ronn simplifies the traditionally tedious process of creating manpages by replacing complex roff/mandoc/mdoc macro languages with an accessible, Markdown-based source format while preserving the structural and typographical benefits of classical manpages.
Overview
the opposite of roff
Use Cases
Best For
- Creating UNIX manual pages for command-line tools
- Generating both terminal and web documentation from a single source
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
