Readme #80

Merged
merged 3 commits into from Apr 26, 2011
View
41 README.md
@@ -21,22 +21,29 @@ template engines included in the distribution.
Support for these template engines is included with the package:
- ENGINE FILE EXTENSIONS REQUIRED LIBRARIES
- -------------------------- ----------------- ----------------------------
- ERB .erb none (included ruby stdlib)
- Interpolated String .str none (included ruby core)
- Haml .haml haml
- Sass .sass haml
- Less CSS .less less
- Builder .builder builder
- Liquid .liquid liquid
- RDiscount .markdown rdiscount
- RedCloth .textile redcloth
- RDoc .rdoc rdoc
- Radius .radius radius
- Markaby .mab markaby
- Nokogiri .nokogiri nokogiri
- CoffeeScript .coffee coffee-script (+node coffee)
+ ENGINE FILE EXTENSIONS REQUIRED LIBRARIES
+ -------------------------- ---------------------- ----------------------------
+ ERB .erb, .rhtml none (included ruby stdlib)
+ Interpolated String .str none (included ruby core)
+ Erubis .erb, .rhtml, .erubis erubis
+ Haml .haml haml
+ Sass .sass haml (< 3.1) or sass (>= 3.1)
+ Scss .scss haml (< 3.1) or sass (>= 3.1)
+ Less CSS .less less
+ Builder .builder builder
+ Liquid .liquid liquid
+ RDiscount .markdown, .mkd, .md rdiscount
+ Redcarpet .markdown, .mkd, .md redcarpet
+ BlueCloth .markdown, .mkd, .md bluecloth
+ Kramdown .markdown, .mkd, .md kramdown
+ Maruku .markdown, .mkd, .md maruku
+ RedCloth .textile redcloth
+ RDoc .rdoc rdoc
+ Radius .radius radius
+ Markaby .mab markaby
+ Nokogiri .nokogiri nokogiri
+ CoffeeScript .coffee coffee-script (+ javascript)
+ Creole (Wiki markup) .creole creole
These template engines ship with their own Tilt integration:
@@ -152,7 +159,7 @@ mappings:
If there are more than one template class registered for a file extension, Tilt
will automatically try to load the version that works on your machine:
- 1. If any of the template engines has been loaded alreaedy: Use that one.
+ 1. If any of the template engines has been loaded already: Use that one.
2. If not, it will try to initialize each of the classes with an empty template.
3. Tilt will use the first that doesn't raise an exception.
4. If however *all* of them failed, Tilt will raise the exception of the first