Contents

# HTML Formatter

A normaliser/formatter for HTML that also understands embedded Ruby and Elixir.
Ideal for tidying up Rails and Phoenix templates.

## What it does

* Normalises hard tabs to spaces (or vice versa)
* Removes trailing spaces
* Indents after opening HTML elements
* Outdents before closing elements
* Collapses multiple whitespace
* Indents after block-opening embedded Ruby or Elixir (if, do etc.)
* Outdents before closing Ruby or Elixir blocks
* Outdents elsif and then indents again
* Indents the left-hand margin of JavaScript and CSS blocks to match the
  indentation level of the code

## Usage

### From the command line

To update files in-place:

``` sh
$ htmlformatter file1 [file2 ...]
```

or to operate on standard input and output:

``` sh
$ htmlformatter < input > output
```

### In your code

```ruby
require 'htmlformatter'

formatted = HtmlFormatter.format(messy)
```

You can also specify how to indent (the default is two spaces):

```ruby
formatted = HtmlFormatter.format(messy, indent: "\t")
```

## Installation

This is a Ruby gem.
To install the command-line tool (you may need `sudo`):

```sh
$ gem install htmlformatter
```

To use the gem with Bundler, add to your `Gemfile`:

```ruby
gem 'htmlformatter'
```

## Contributing

1. Follow [these guidelines][git-commit] when writing commit messages (briefly,
   the first line should begin with a capital letter, use the imperative mood,
   be no more than 50 characters, and not end with a period).
2. Include tests.

[git-commit]:http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
htmlformatter-1.5.3	README.md
htmlformatter-1.5.1	README.md
htmlformatter-1.5.0	README.md