HTML Encoder

This is CodeRay’s most important highlighter: It provides save, fast XHTML generation and CSS support.

Usage

 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

Options

:tab_width

Convert \t characters to n spaces (a number.) Default: 8

:css

How to include the styles; can be :class or :style.

Default: :class

:wrap

Wrap in :page, :div, :span or nil.

You can also use Encoders::Div and Encoders::Span.

Default: nil

:line_numbers

Include line numbers in :table, :inline, :list or nil (no line numbers)

Default: nil

:line_number_start

Where to start with line number counting.

Default: 1

:bold_every

Make every n-th number appear bold.

Default: 10

:hint

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