Every repository with this icon (
) is private.
Every repository with this icon (
) is public.
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 |
→ |
|
| # one # two |
→ |
|
Try it out at the RedCloth Textile Dingus
Installing
Using RubyGems
$ gem install RedClothNB: RedCloth is CamelCase, not lowercase. Do a gem install redcloth and 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 can be found on redcloth.org
Bugs and contributions
Bug tracking is on Lighthouse. Please only report bugs about RedCloth 4.0. The 3.0.4 version’s bugs are many and well-known
If you have a change you would like to contribute:
- fork on GitHub
git cloneyour fork- add tests to show how the expected behavior is not occurring
- write code until the tests pass
- send a pull request on GitHub
Community
Have a question about RedCloth or want to follow its latest developments? Join the mailing list.
