kotovalexarian-likes-github
/
haml--haml
mirror of https://github.com/haml/haml.git
1
0
Fork 0
Code Releases Activity

Clean up the Using section of the README.

This commit is contained in:
Nathan Weizenbaum 2009-06-21 16:27:00 -07:00
parent 34e442d9b9
commit 3d490d2207
1 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -11,24 +11,34 @@ and providing elegant, easily understandable, and powerful syntax.
## Using ## Using
There are several ways to use Haml and Sass. Haml and Sass can be used from the command line
They can be used as a plugin for Rails or Merb, or as part of a Ruby web framework.
or embedded on their own in other applications. The first step is to install the gem:
The first step of all of these is to install the Haml gem:
gem install haml gem install haml
After you convert some HTML to Haml or some CSS to Sass,
you can run
haml document.haml
sass style.sass
to compile them.
For more information on these commands, check out
haml --help
sass --help
To install Haml and Sass as a Rails plugin, To install Haml and Sass as a Rails plugin,
just run `haml --rails path/to/rails/app` just run `haml --rails path/to/rails/app`
and both Haml and Sass will be installed. and both Haml and Sass will be installed.
Views with the `.haml` (or `.html.haml` for edge) Views with the `.html.haml` extension will automatically use Haml.
extension will automatically use Haml.
Sass is a little more complicated; Sass is a little more complicated;
`.sass` files should be placed in public/stylesheets/sass, `.sass` files should be placed in `public/stylesheets/sass`,
where they'll be automatically compiled where they'll be automatically compiled
to corresponding CSS files in public/stylesheets when needed to corresponding CSS files in `public/stylesheets` when needed
(the Sass template directory is customizable... (the Sass template directory is customizable...
see the Sass module docs for details). see [the Sass reference](http://sass-lang.com/docs/yardoc/SASS_REFERENCE.md.html#template_location-option) for details).
For Merb, `.html.haml` views will work without any further modification. For Merb, `.html.haml` views will work without any further modification.
To enable Sass, you also need to add a dependency. To enable Sass, you also need to add a dependency.
@ -36,11 +46,11 @@ To do so, just add
dependency "merb-haml" dependency "merb-haml"
to config/dependencies.rb (or config/init.rb in a flat/very flat Merb application). to `config/dependencies.rb` (or `config/init.rb` in a flat/very flat Merb application).
Then it'll work just like it does in Rails. Then it'll work just like it does in Rails.
To use Haml and Sass programatically, To use Haml and Sass programatically,
check out the RDocs for the Haml and Sass modules. check out the [YARD documentation](http://haml-lang.com/docs/yardoc).
## Formatting ## Formatting