🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

redclothcoderay

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

redclothcoderay

0.3.6
Version published
Maintainers
2
Created

== Redcloth with CodeRay

Adds CodeRay syntax highlighting support to RedCloth, with a 'source' tag. See the examples below.

A short summary of what you can do:

  • foo - Use this tag to produce CodeRay highlighted HTML for the contents within that tag. The language defaults to Ruby.
  • source:cssfoo - Highlight as usual, but highlight as CSS. Supports everything CodeRay supports. Refer to the CodeRay documentation for a list of supported languages.
  • You can also use the tag.

== Installing

Installation as usual:

sudo gem install redclothcoderay

You can also install the gem via github, to get the latest HEAD.

sudo gem install augustl-redclothcoderay --source=http://gems.github.com/

== Using

A short example.

require 'rubygems' require 'redcloth' require 'coderay' require 'redclothcoderay'

RedCloth.new('I am bold and @hi_tech').to_html

You can specify the CodeRay options, too (defaults to RedclothCoderay::CODERAY_OPTIONS).

RedclothCoderay.coderay_options :line_numbers => :table

== Example

This input:

Hello, this is textilized. It also has @inline_code_examples!

What about a multi-line code sample?

source:html

Hello, world!

Produces this output (indented for clarity):

Hello, this is textilized. It also has @inline_code_examples !

What about a multi-line code sample?

<h1>Hello, world!</h1>

FAQs

Package last updated on 15 Nov 2009

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts