nesquena/markdown_yard.md

Created November 29, 2011 21:51

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/nesquena/1406718.js"></script>
Save nesquena/1406718 to your computer and use it in GitHub Desktop.

Github Flavored Markdown in YARD

Raw

Github Flavored YARD

# Gemfile

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

And in .yardopts:

# .yardopts

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

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