Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

update docs to reflect new renderer and jruby support

  • Loading branch information...
commit 4cc46a1a891270055d681215557d69006884f4c3 1 parent adbacc9
@zzak authored
Showing with 8 additions and 8 deletions.
  1. +6 −5 README.md
  2. +1 −1  glorify.gemspec
  3. +1 −2  lib/glorify/template.rb
View
11 README.md
@@ -4,15 +4,16 @@
Sinatra helper to parse markdown with syntax highlighting like the pros
-Renders markdown via redcarpet with syntax highlighting thanks to
-[rouge](https://github.com/jayferd/rouge).
+Renders markdown via [rdoc-rouge](https://github.com/zzak/rdoc-rouge), an
+[RDoc](https://github.com/rdoc/rdoc) and
+[Rouge](https://github.com/jayferd/rouge) bridge.
Able to use fenced code blocks like github, and includes a default pygments
stylesheet.
## Requirements
-Ruby 1.9.2 or greater, or Rubinius in 1.9 mode.
+Ruby 1.9.2 or greater, also supports JRuby and Rubinius when using 1.9 modes.
## Installation
@@ -32,8 +33,8 @@ gem 'glorify'
Sinatra::Glorify comes with a tilt template for rendering markdown.
-This allows you to override the default markdown renderer and use `redcarpet`
-with `rouge` to highlight any code blocks within your view.
+This allows you to override the default markdown renderer and use `rdoc-rouge`
+to highlight any code blocks within your view.
In order to do this, you will need to prefer the template class.
View
2  glorify.gemspec
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
s.email = ["zachary@zacharyscott.net"]
s.homepage = "http://zacharyscott.net/glorify/"
s.summary = %q{Sinatra helper to parse markdown with syntax highlighting like the pros}
- s.description = %q{Renders markdown via redcarpet with syntax highlighting thanks to rouge. Able to use fenced code blocks like github, and includes a default pygments stylesheet.}
+ s.description = %q{Renders markdown via rdoc-rouge, an RDoc and Rouge bridge. Able to use fenced code blocks like github, and includes a default pygments stylesheet.}
s.files = `git ls-files`.split("\n")
s.require_paths = ["lib"]
View
3  lib/glorify/template.rb
@@ -5,8 +5,7 @@ module Glorify
# Sinatra::Glorify comes with a tilt template for rendering markdown.
#
# This allows you to override the default markdown renderer and use
- # +redcarpet+ with +rouge+ to highlight any code blocks within your
- # view.
+ # +rdoc-rouge+ to highlight any code blocks within your view.
#
# In order to do this, you will need to prefer the template class.
#
Please sign in to comment.
Something went wrong with that request. Please try again.