Would you like to do this in your README.md :
And get this as the output :
In your Gemfile :
In your .yardopts file :
```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
- YARD Doc
- Github flavored Markdown
- Markdown
- The original issue on YARD's bugtracker
- Bundler

0 comments:
Post a Comment