Module: Rack::Coderay

Defined in:
lib/rack/coderay.rb,
lib/rack/coderay/parser.rb

Overview

CodeRay Syntax Highlighter Rack Appliance

Rack::Coderay parses text/html markup and replaces code with output from the CodeRay gem (coderay.rubychan.de/), producing syntax highlighting. By default, this component looks for <pre lang=“xxxx”>…</pre> blocks, where 'xxxx' is any of the languages supported by CodeRay (e.g. 'ruby'). See coderay.rubychan.de/doc/classes/CodeRay/Scanners.html

You can re-configure Rack::Coderay to look for a different trigger but it needs to have a 'lang' attribute.

Usage

Within a rackup file (or with Rack::Builder):

require 'rack/coderay'
use Rack::Coderay
run app

Rails example:

# above Rails::Initializer block
require 'rack/coderay'

# inside Rails::Initializer block 
config.middleware.use Rack::Coderay

To override the default markup trigger (<pre lang=“xxxx”>), you can pass in a css or xpath selector as the second argument:

config.middleware.use Rack::Coderay, "//div[@lang]"

To set additional CodeRay gem options, pass a hash as the third argument:

config.middleware.use Rack::Coderay, 
  "//pre[@lang]", 
  :line_numbers => :table

Defined Under Namespace

Classes: Parser

Class Method Summary collapse

Class Method Details

.new(backend, markup_trigger = "//pre[@lang]", options = {}) ⇒ Object

Create a new Rack::Coderay middleware component that automatically highlights syntax using the CodeRay gem.


43
44
45
# File 'lib/rack/coderay.rb', line 43

def self.new(backend, markup_trigger = "//pre[@lang]", options = {})
  Parser.new(backend, markup_trigger, options)
end