https://github.com/matiaskorhonen/redcloth-with-coderay

Adds CodeRay syntax highlighting to RedCloth, by using a source tag
https://github.com/matiaskorhonen/redcloth-with-coderay

unmaintained

Last synced: 28 days ago
JSON representation

Adds CodeRay syntax highlighting to RedCloth, by using a source tag

• Host: GitHub
• URL: https://github.com/matiaskorhonen/redcloth-with-coderay
• Owner: matiaskorhonen
• License: mit
• Created: 2009-08-12T12:44:20.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2009-11-15T14:22:06.000Z (about 15 years ago)
• Last Synced: 2024-10-31T14:42:42.634Z (about 2 months ago)
• Topics: unmaintained
• Language: Ruby
• Homepage: http://redclothcoderay.rubyforge.org/
• Size: 113 KB
• Stars: 1
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
== 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.

* foo - 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?

 

 
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>