Project

rdoc-rouge

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Syntax highlighting for RDoc using the pygments friendly Rouge.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0

Runtime

~> 4.0
~> 0.3.0
 Project Readme

RDoc::Rouge

Build Status

Syntax highlighting for RDoc using the pygments friendly Rouge.

Installation

Add this line to your application's Gemfile:

gem 'rdoc-rouge'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rdoc-rouge

Usage

require 'rdoc/rouge'
renderer = RDoc::Rouge::Renderer
html = renderer.parse <<-markdown
```ruby
def hello(who)
  puts "Hello, #{who}!"
end
```
markdown

If you just want to generate a table of contents from your markdown, we have exposed RDoc::Markup::ToTableOfContents

RDoc::Rouge::Renderer.new(:toc => true).parse("# markdown")
#=> "<li><a href='#label-markdown'>markdown</a></li>"

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