This is CodeRay’s most important highlighter: It provides save, fast XHTML generation and CSS support.
require 'coderay' puts CodeRay.scan('Some /code/', :ruby).html #-> a HTML page puts CodeRay.scan('Some /code/', :ruby).html(:wrap => :span) #-> <span class="CodeRay"><span class="co">Some</span> /code/</span> puts CodeRay.scan('Some /code/', :ruby).span #-> the same puts CodeRay.scan('Some code', :ruby).html( :wrap => nil, :line_numbers => :inline, :css => :style ) #-> <span class="no">1</span> <span style="color:#036; font-weight:bold;">Some</span> code
Convert t characters to n spaces (a number.) Default: 8
How to include the styles; can be :class or :style.
Default: :class
Wrap in :page, :div, :span or nil.
You can also use Encoders::Div and Encoders::Span.
Default: nil
The title of the HTML page (works only when :wrap is set to :page.)
Default: ‘CodeRay output’
Include line numbers in :table, :inline, :list or nil (no line numbers)
Default: nil
Where to start with line number counting.
Default: 1
Make every n-th number appear bold.
Default: 10
Highlights certain line numbers. Can be any Enumerable, typically just an Array or Range, of numbers.
Bolding is deactivated when :highlight_lines is set. It only makes sense in combination with :line_numbers.
Default: nil
Include some information into the output using the title attribute. Can be :info (show token type on mouse-over), :info_long (with full path) or :debug (via inspect).
Default: false
ansi_chars = Array(0x7f..0xff) ansi_chars.each { |i| HTML_ESCAPE = ’&#%d;’ % i }
\x9 (\t) and \xA (\n) not included
HTML_ESCAPE_PATTERN = /[t&”><0-x8xB-x1fx7f-xff]/
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.