{"repo":"skatkov/rdoc-markdown","free":true,"listed":false,"github":"https://github.com/skatkov/rdoc-markdown","clone":"git clone https://github.com/skatkov/rdoc-markdown.git","description":"RDoc plugin to output markdown documentation","language":"Ruby","stars":26,"topics":["generator","markdown","rdoc","ruby"],"license":"GPL-3.0","category":"productivity","readme_excerpt":"RDoc-Markdown RDoc plugin to generate markdown documentation and search index file (CSV). [!CAUTION] This gem relies on multiple hacks to generate \"plausible\" markdown documentation. This is NOT PRODUCTION READY — use at your own risk. RDoc maintainers are actively working on markdown support, things will improve with time... Motivation Markdown has become the de facto documentation standard. We can render markdown files on any device, possibly on a thermometer with a screen. And everyone knows markdown... It's a pity that RDoc can't output a proper markdown file. Somebody has to try to build it. Installation rdoc-markdown requires Ruby 3.3 or newer and RDoc 8 or newer. Install the gem and add it to your application's Gemfile by executing: $ bundle add rdoc-markdown If Bundler is not being used to manage dependencies, install the gem by executing: $ gem install rdoc-markdown Usage RDoc will auto-detect the rdoc-markdown plugin if it is installed. You just need to instruct RDoc to produce markdown output instead of standard HTML through the format parameter. Run the following command in a directory with Ruby source code: rdoc --format=markdown Development or you can do the same through a Gemfile: Testing The following command should run the entire test suite: To validate generated markdown against GitHub Flavored Markdown and check local links/anchors: To lint markdown ERB templates: Generate vendored docs Use rake tasks to generate markdown output for vendored projects: ./bin","default_branch":null,"files":null,"tree":[],"storefront":"/r/skatkov","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/skatkov/rdoc-markdown/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."}