[Haml] Update reference with a plugin section.

This commit is contained in:
Nathan Weizenbaum 2009-06-25 00:28:49 -07:00
parent f730c1cfe5
commit 908b15f1bb
1 changed files with 12 additions and 10 deletions

View File

@ -24,27 +24,29 @@ with some code to generate dynamic content.
## Using Haml
Haml can be used in three ways:
as a command-line tool,
as a plugin for Ruby on Rails,
as a standalone Ruby module,
and as a command-line tool.
and as a standalone Ruby module.
The first step for all of these is to install the Haml gem:
gem install haml
To enable it as a Rails plugin,
then run
haml --rails path/to/rails/app
Once it's installed, all view files with the `".html.haml"` extension
will be compiled using Haml.
To run Haml from the command line, just use
haml input.haml output.html
Use `haml --help` for full documentation.
### Rails/Merb Plugin {#plugin}
To enable Haml as a Rails plugin, run
haml --rails path/to/rails/app
Once it's installed, all view files with the `".html.haml"` extension
will be compiled using Haml.
Haml is enabled by default in Merb.
You can access instance variables in Haml templates
the same way you do in ERB templates.
Helper methods are also available in Haml templates.