{"repo":"postmodern/kramdown-man","free":true,"listed":false,"github":"https://github.com/postmodern/kramdown-man","clone":"git clone https://github.com/postmodern/kramdown-man.git","description":"Allows you to write man pages in pure markdown.","language":"Ruby","stars":87,"topics":["man-page","markdown","markdown-converter","roff"],"license":"MIT","category":"productivity","readme_excerpt":"kramdown-man Homepage Issues Documentation Description Allows you to write man pages for commands in pure Markdown and convert them to roff using [Kramdown][kramdown]. Features Converts markdown to [roff]: Supports codespans, emphasis, and strong fonts. Supports normal and tagged paragraphs. Supports codeblocks and blockquotes. Supports bullet, numbered, and definition lists. Supports multi-paragraph list items and blockquotes. Supports converting foo-bar and bash) links into SEE ALSO man page references. Provides a handy kramdown-man command for converting or previewing markdown man pages. Provides a rake task for converting man/ .md into man pages. Uses the pure-Ruby [Kramdown][kramdown] markdown parser. Supports [Ruby] 3.x, [JRuby], and [TruffleRuby]. Synopsis Render a man page from markdown: Preview the rendered man page: Examples Render a man page from a markdown file: Rake Task Define a man and file tasks which render all .md files within the man/ directory: Then you can generate man pages for all .md in the man/ directory: Syntax Code code Emphasis emphasis Strong strong Paragraph Normal paragraph. Usage String command [ --foo ] FILE Argument Definitions ARG : Description here. Option Definitions -o , --option VALUE : Description here. Links website Man Pages Link to other man pages in a project: kramdown-man Link to other system man page: bash) Note: only works on [firefox] on Linux. [firefox]: https://www.mozilla.org/en-US/firefox/new/ Email Addresses Email Lists one","default_branch":null,"files":null,"tree":[],"storefront":"/r/postmodern","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/postmodern/kramdown-man/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}