Github Flavored Markdown in YARD

markdown_yard.md

Github Flavored YARD

Thanks to http://blog.nikosd.com/2011/11/github-flavored-markdown-in-yard.html

# Gemfile

group :development do
  gem 'yard'
  gem 'redcarpet'
  gem 'github-markup'
end

And in .yardopts:

# .yardopts

--markup-provider=redcarpet
--markup=markdown

Old information. See point 15 in Changelog here: http://rubydoc.info/docs/yard/file/docs/WhatsNew.md#What_s_New_in_0_7_x_

I can't make a GFM table work with any of these solutions. Only block fences are working ok. :(

this works for ruby gem yard documentation (with gems listed in gemspec instead of Gemfile). thanks!

I'm using Yard 0.9.2 but having trouble getting this to work. It might be because I am developing a gem instead of a regular app, but doing the above worked for me. I did not need to include the github-markup gem, just the redcarpet one and update the .yardopts with -m markdown -M redcarpet.

Quick note, you'll also need yard-coderay if you want it to highlight languages other than Ruby: lsegal/yard#1278

Since https://github.com/lsegal/yard/releases/tag/v0.9.27 CommonMarker is supported! lsegal/yard#1388