Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.08 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.08 KB
Raw

Yard::Markdown

Yard plugin to generate markdown documentation

Goals:

  • 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
  • Include markdown files that are already present in source code.

Usage

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.

Backstory

This is a successor to rdoc-mardown gem with small differences in implementation. This gem was written to power API documentation browser CLI app for ruby developers called POSH TUI.

Testing

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

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