Convert gem's man-pages to HTML pages and host them under `/docs/`

ronin-rb / ronin-rb.github.io

The ronin-rb.dev website

https://ronin-rb.dev

GNU General Public License v3.0

26 stars 21 forks source link

Convert gem's man-pages to HTML pages and host them under `/docs/` #45

Closed postmodern closed 3 months ago

postmodern commented 1 year ago

The man-pages from all of the gems should be hosted under /docs/ as HTML pages. This is difficult because they use a specialized form of markdown which is converted to roff (man-page's markup) by kramdown-man. Will need to either convert the raw roff output to HTML, or write a custom man-page Markdown -> HTML Kramdown Converter.

postmodern commented 1 year ago

See bundler's website's rake task as an example of how to convert markdown man-pages into jekyll pages. We could probably define a task which did similar mangling to the man/*.md files to convert them to Jekyll pages. Then we'd just need a special _layout/ for the jekyll man-pages and special CSS for the page's text contents.

postmodern commented 3 months ago

This has been implemented by c050b639e404b4c03e84f7e90764fe011e1567d0.