Home

About RedCloth

RedCloth is a module for using Textile in Ruby. Textile is a simple text format that can be converted to HTML. It’s used on wikis, blogging engines, bug trackers, this site—pretty much everywhere.

textile	to	html
_emphasized_	→	emphasized
*strong*	→	strong
"Ruby on Rails":http://www.rubyonrails.org	→	Ruby on Rails
* an item * and another	→	an item and another
# one # two	→	one two

Try it out at the “RedCloth Textile Dingus” (original link was http://redcloth.org/try-redcloth/ but it is not up & running), so if you read this and want to try it out, please create an issue.

Installing

Using RubyGems

$ gem install RedCloth

NB: RedCloth is UpperCamelCase, not lowercase. If you try gem install redcloth you’ll get ERROR: could not find redcloth locally or in a repository.

From source

To install from source, get it from the repository:

$ git clone git://github.com/jgarber/redcloth.git
$ cd redcloth
$ rake install

You’ll need the latest Ragel to compile it.

Textile Reference Manual

The “RedCloth Textile Reference Manual” (original location: http://redcloth.org/textile is not up & running) can be found on “redcloth.org” (original location: http://redcloth.org is not up & running). If you read this and find yourself interested, please create an issue.

Bugs and contributions

If you find a bug, open an issue and describe the behavior.
Please only report bugs about RedCloth 4.

If you have a change you would like to contribute:

1. fork on GitHub
2. git clone your fork
3. add tests to show how the expected behavior is not occurring
4. write code until the tests pass
5. send a pull request on GitHub

Community

Have a question about RedCloth or want to follow its latest developments? Open an issue or if you see the Discussions tab.