Get RedCloth 3
Stable version: 3.0.3
Take a complete tour of Textile at A Textile Reference.
For fast syntax checking, try the Quick Reference.
Upgrade with RubyGems! Try:
gem install RedCloth.
See the project page for bug reporting, old releases and CVS instructions. Documentation is also hosted at RubyForge.
RedCloth Links
Instiki is the greatest Wiki ever! Uses RedCloth for its markup!
Hobix is a lovely little blogging package which uses RedCloth for blog entries.
RedCloth is a module for using Textile in Ruby. Textile is a text format. A very simple text format. Another stab at making readable text that can be converted to HTML.
What is Textile?
Textile is a simple markup language.
| textile | to | html |
|---|---|---|
| _a phrase_ | -> | a phrase |
| *a phrase* | -> | a phrase |
| _*a phrase*_ | -> | a phrase |
| "Google":http://google.com | -> |
No need to use verbose HTML to build your docs, your blogs, your pages. Textile gives you readable text while you’re writing and beautiful text for your readers. And if you need to break out into HTML, Textile will allow you to do so.
Textile also handles some subtleties of formatting which will enhance your document’s readability:
- Single- and double-quotes around words or phrases are converted to curly quotations, much easier on the eye. “Observe!”
- Double hyphens are replaced with an em-dash. Observe—very nice!
- Single hyphens are replaced with en-dashes. Observe – so cute!
- Triplets of periods become an ellipsis. Observe…
- The letter ‘x’ becomes a dimension sign when used alone. Observe: 2×2.
- Conversion of (TM) to™, (R) to®, (C) to©.
For more on Textile’s language, hop over to A Textile Reference.
Using RedCloth
The RedCloth class is an extension of Ruby’s String class. Use it like you would a String:
>> r = RedCloth.new "*strong text* and _emphasized text_" => "*strong text* and _emphasized text_" >> r.gsub!( 'text', 'words' ) => "*strong words* and _emphasized words_"
To generate HTML from your RedCloth object, use the RedCloth#to_html method:
>> r.to_html => "<p><strong>strong words</strong> and <em>emphasized words</em></p>"
Installing RedCloth
To install RedCloth via RubyGems:
gem install RedCloth
Or download RedCloth and simply run the install.rb like so:
ruby install.rb config ruby install.rb setup sudo ruby install.rb install
Acknowledgements
Textile is© 2003 Dean Allen. All rights reserved. You can read more here.
RedCloth is also based on PyTextile, which is: Copyright© 2003, Mark Pilgrim. All rights reserved. You can read more about PyTextile here.
| Classes | |
|---|---|
| RedCloth | RedCloth is a Ruby library for converting Textile and/or Markdown into HTML. You can use either format, intermingled or separately. You can also extend RedCloth to honor your own custom text stylings. |
<code/>and<pre/>for code samples.