Yard::Markdown

Yard plugin to generate markdown documentation

• Compatible with Github Flavored Markdown
• Mimick yard html layout where it makes sense to maintain familiarity
• Produce .csv index file alonside markdown documentation to act as file index

Yard doesn't load plugin by default, so you need to load plugin through ~/.yard/config:

!!!yaml
load_plugins: true
autoload_plugins:
  - markdown

Install a plugin

gem install yard-markdown

Run yardoc --format=markdown to generate markdown documentation.

This is a successor to rdoc-mardown gem. These docsets are used in POSH TUI.

Unit tests can't really test this gem properly. So it's semi-manual process of making changes and reviewing output.

yardoc example_rdoc.rb -> outputs everything into example/ folder.

yardoc example_yard.rb -> outputs everything into example/ folder.