Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 3.61 KB

README.md

File metadata and controls

90 lines (60 loc) · 3.61 KB

Html2haml

Build Status Code Climate Gem Version

Html2haml, not surprisingly, converts HTML to Haml. It works on HTML with embedded ERB tags as well as plain old HTML.

Installation

Add this line to your application's Gemfile:

gem 'html2haml'

And then execute:

$ bundle

Or install it yourself as:

$ gem install html2haml

Usage

To convert a project from .erb to .haml

If your system has sed and xargs available and none of your .erb file names have whitespace in them, you can convert all your templates like so:

find . -name \*.erb -print | sed 'p;s/.erb$/.haml/' | xargs -n2 html2haml

If some of your file names have whitespace or you need finer-grained control over the process, you can convert your files using gsed or multi-line script techniques discussed here.

Documentation

About version 2.0

Html2haml 2.0 differs from 1.x primarily in that it uses Nokgiri as its HTML parser rather than Hpricot. At the current time however, there are some problems running Html2haml 2.0 on JRuby due to differences in the way the Java version of Nokogiri parses HTML. If you are using JRuby you may wish to run HTML2Haml on MRI or use a 1.x version until these problems have been resolved.

Options

Here are the options currently available to Html2haml:

See html2haml --help:

Usage: html2haml [options] [INPUT] [OUTPUT]

Description: Transforms an HTML file into corresponding Haml code.

Options:
    -e, --erb                        Parse ERB tags.
        --no-erb                     Don't parse ERB tags.
        --html-attributes            Use HTML style attributes instead of Ruby hash style.
        --ruby19-attributes          Use Ruby 1.9-style attributes when possible.
    -E ex[:in]                       Specify the default external and internal character encodings.
    -s, --stdin                      Read input from standard input instead of an input file
        --trace                      Show a full traceback on error
        --unix-newlines              Use Unix-style newlines in written files.
    -?, -h, --help                   Show this message
    -v, --version                    Print version

License

Copyright (c) 2006-2017 Hampton Catlin, Natalie Weizenbaum and Norman Clarke

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.