Contents

• Description
• Examples

Back to the extension listing.

Webgen::Tag::Coderay

Summary

The following tag names are registered for this tag class: coderay

This tag uses the following options:

• tag.coderay.lang (mandatory default)
• tag.coderay.process_body
• tag.coderay.wrap
• tag.coderay.line_numbers
• tag.coderay.line_number_start
• tag.coderay.bold_every
• tag.coderay.tab_width
• tag.coderay.css

Description

This tag applies syntax highlighting to its body by using the coderay library which can be used to highlight many different languages (see tag.coderay.lang documentation). The body of the tag specifies what should be highlighted.

By using the configuration option tag.coderay.css you can specify whether you want to have inline styles, the default external stylesheet file or your own stylesheet file.

It is easy to include and highlight an entire file by combining this tag with the include_file tag:

{coderay:: ruby}{include_file: test.rb}{coderay}

This extension is only available if you have installed the coderay library. The preferred way to do this is via Rubygems:

gem install coderay

Examples

1 # -*- encoding: utf-8 -*-
2 
3 module Webgen
4 
5   # The version of webgen.
6   VERSION = '0.5.14'
7 
8 end

Back to the extension listing.