Sha256: 54f4829b875e8b5f34b7208522befa04bd6f5d9b6988a29e1b1e8f97c5daf294
Contents?: true
Size: 1.22 KB
Versions: 1
Compression:
Stored size: 1.22 KB
Contents
# 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 !!!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](https://github.com/skatkov/rdoc-markdown/tree/main/example) with small differences in implementation. This gem was written to power API documentation browser CLI app for ruby developers called [POSH TUI](https://poshtui.com). ## Testing Unit tests can't really test this gem properly. So it's semi-manual process of making changes and reviewing output. Testing Rdoc conversion to markdown: `yardoc example_rdoc.rb` -> outputs everything into example/ folder. Testing Yard conversion to markdown: `yardoc example_yard.rb` -> outputs everything into example/ folder.
Version data entries
1 entries across 1 versions & 1 rubygems
Version | Path |
---|---|
yard-markdown-0.4 | README.md |