{"repo":"skatkov/yard-markdown","free":true,"listed":false,"github":"https://github.com/skatkov/yard-markdown","clone":"git clone https://github.com/skatkov/yard-markdown.git","description":"yard plugin to generate markdown documentation","language":"Ruby","stars":18,"topics":["markdown","yard"],"license":"MIT","category":"productivity","readme_excerpt":"Yard::Markdown Yard plugin to output markdown documentation. Motivation Markdown has become the de-facto documentation standard. I heavily rely on Obsidian to render my storage of markdown notes. But markdown is used not just for scribbles, supported is far and wide. We can render markdown file on any device, probably even on thermometer with a screen. But also everyone knows enough markdown to be dangerous (or productive). It's a pitty that rdoc and yard can't output a proper markdown file. I would like to change that. Goals: - Compatible with Github Flavored Markdown - Produce .csv index file - Mimick yard html layout where it makes sense to maintain familiarity Usage Install a plugin Run yardoc --format=markdown to generate markdown documentation. Markdown files in the project tree are detected automatically, copied unchanged into the output, and listed in index.csv : Markdown files whose basename starts with are ignored automatically. Use YARD's --exclude option to omit a separate documentation tree: FAQ Note on RDoc support It seems important to note, that yard claims to have support for RDoc. That support is certainly present, but output for rdoc is dramatically different. A lot of useful information seems lost in the process. If you know how to improve that, please get in touch or submit a patch. So in meantime, there is work going on a competing gem for RDoc and it's called rdoc-markdown gem. Note on index.csv file This gem emits index of all markdown files in a index","default_branch":null,"files":null,"tree":[],"storefront":"/r/skatkov","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/skatkov/yard-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."}