Github flavored markdown in YARD documentation

Tuesday, November 22, 2011
Would you like to do this in your README.md :

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

And get this as the output :


In your Gemfile :

  gem 'yard'
  gem 'redcarpet'
  gem 'github-markup'

In your .yardopts file :

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

Resources


1 comments:

  • Josh

    Thanks for this useful post. But to my experience, only the yard and redcarpet gems are needed, and only --markup=markdown. Maybe the rest is by default now?

  • Post a Comment