Highlight¶ ↑

Highlight is a simple syntax highlighting plugin for Ruby on Rails. It’s basically a wrapper around the popular pygments.org highlighter that’s written in Python and supports a huge number of languages.

See the API docs at docs.github.com/marcoow/highlight.

The CI server is at ci.simplabs.com/highlight.

Highlight provides a new method that’s available in views:

highlight(language, code = nil, &block)

language may be either a Symbolor a String (see supported languages below). The code can be passed either as a string or inside a block, e.g.:

highlight(:ruby, 'class Test; end')

highlight(:ruby) do
  <<-EOF
    class Test
      end
  EOF
end

To perform the highlighting, the code is first written to a file in /tmp, e.g.:

/tmp/highlight_1225993290.70882

This file is the passed to pygments that returns the HTML and so on…

Since writing that file, passing its contents on to pygments, retrieve the result etc. takes a while, all highlighted source code should be cached of course, e.g.:

<% cache do %>
  <%= highlight(:ruby, 'class Test; end') -%>
<% end %>

Supported Languages¶ ↑

The following languages are supported. All of the paranthesized identifiers may be used as parameters for highlight to denote the language the source code to highlight is written in (use either Symbols or Strings).

* Actionscript (as, as3, actionscript)
* Applescript (applescript)
* bash (bash, sh)
* C (c, h)
* Clojure (clojure)
* C++ (c++, cpp, hpp)
* C# (c#, csharp, cs)
* CSS (css)
* diff (diff)
* Dylan (dylan)
* Erlang (erlang, erl, er)
* HTML (html, htm)
* Java (java)
* JavaScript (javascript, js, jscript)
* JSP (jsp)
* Make (make, basemake, makefile)
* Objective-C (objective-c)
* OCaml (ocaml)
* Perl (perl, pl)
* PHP (php)
* Python (python, (py)
* RHTML (erb, rhtml)
* Ruby (ruby, rb)
* Scala (scala)
* Scheme (scheme)
* Smalltalk (smalltalk)
* Smarty (smarty)
* SQL (sql)
* XML (xml, xsd)
* XSLT (xslt)
* YAML (yaml, yml)

Installation¶ ↑

Installation is as easy as (for Rails > 2.1):

./script/plugin install git@github.com:marcoow/highlight.git

The hightlight.css stylesheet that contains the neccessary style definitions should be copied to your public/stylesheets directory automagically.

If you are on Rails < 2.1, do this from your RAILS_ROOT

git clone git@github.com:marcoow/highlight.git vendor/plugins/highlight

In this case you would have to copy the hightlight.css stylesheets manually from vendor/plugins/highlight/assets/stylesheets/.

If you don’t have python and pygments installed, you will need that too. For instructions on installing pygments, refer to pygments.org/docs/installation/

TODOs/ future plans¶ ↑

At the moment there are neither TODOs nor future plans. If you want ot suggest any, do so at github.com/marcoow/highlight/issues.

Author¶ ↑

Acknowledgements¶ ↑