YARD::Redcarpet::Ext
Enables Redcarpet extensions for YARD.
Installation
Add this line to your application's Gemfile:
gem 'yard-redcarpet-ext'
And then execute:
$ bundle
Or install it yourself as:
$ gem install yard-redcarpet-ext
Usage
Add --plugin redcarpet-ext
option to your .yardopts
or call yard
with this option.
Create new file named .yard_redcarpet_ext
with all needed Redcarpet extensions like tables separated by comma or newline.
Another way to specify extensions is setting of YARD_REDCARPET_EXTS environment variable. Extensions should be separated by comma.
You must have gem 'yard-redcarpet-ext'
string in your Gemfile or development dependency in gemspec if it exists.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request