No commit activity in last 3 years
No release in over 3 years
Redcarpet extensions for YARD
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 1.3
>= 0

Runtime

~> 0.8.0
 Project Readme

YARD::Redcarpet::Ext

Gem Version

Enables Redcarpet extensions for YARD. Tables enabled by default, as GitHub does.

This extension enabled on http://rubydoc.info/.

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.

Allowed Redcarpet extensions listed at: https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use

By default yard-redcarpet-ext enable these ones: no_intraemphasis, gh_blockcode, fenced_code, autolink and tables.

Removing of extensions from the list

Simply add extension to be removed to the list prefixed by minus sign, like -tables.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request