Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ink is a Ruby wrapper for Pygments, a nice Python syntax highlighting library and formatters like RDoc, Markdown and Textile.
tree: f3949d238e

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
samples
stylesheets
test
.gitignore
README.rdoc
Rakefile
ink.gemspec

README.rdoc

Introduction

Ink is a wrapper for Pygments, a nice Python syntax highlighting library, and formatters like RDoc, Markdown and Textile.

Install

sudo gem install ink

If you want the source go to github.com/fnando/ink

Usage

require "rubygems"
require "ink"

# Setting pygmentize when is not in your $PATH
Ink::Highlight.bin = "/other/path/pygmentize"

# Syntax highlighting
Ink::Highlight.highlight("Rakefile")
Ink::Highlight.highlight("Rakefile", :format => :terminal)
Ink::Highlight.highlight("Rakefile", :language => "rb")
Ink::Highlight.highlight("Rakefile", :guess => :filename)
Ink::Highlight.highlight("Rakefile", :guess => :content)

# Formatting
Ink::Formatter.format(@code, "Rakefile")

Ruby on Rails

You can add the Ink::Helper module.

module ApplicationHelper
  include Ink::Helper
end

This module adds two methods.

<%= highlight @code, :file => "Rakefile" %>
<%= highlight @code, :language => :ruby %>

<%= format @code, "Rakefile" %>

Commandline

Obviously, you'll need the CSS for the highlighted source. You can view the available list by running

$ ink list

Finally, you can retrieve the CSS with the command below:

$ ink show [NAME] > [NAME].css

TODO

  • Add preview option to the ink command

License

(The MIT License)

Copyright © 2010:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.