Sha256: 7485d29fed74bb1875443030d1a7587e8aa732d0ed70b6570a4c763d262d1c07

Contents?: true

Size: 1.53 KB

Versions: 9

Compression:

Stored size: 1.53 KB

Contents

# HTML Beautifier

A normaliser/beautifier for HTML that also understands embedded Ruby.
Ideal for tidying up Rails 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 (if, do etc.)
* Outdents before closing Ruby 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
$ htmlbeautifier file1 [file2 ...]
```

or to operate on standard input and output:

``` sh
$ htmlbeautifier < input > output
```

### In your code

```ruby
require 'htmlbeautifier'

beautiful = HtmlBeautifier.beautify(messy)
```

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

```ruby
beautiful = HtmlBeautifier.beautify(messy, indent: "\t")
```

## Installation

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

```sh
$ gem install htmlbeautifier
```

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

```ruby
gem 'htmlbeautifier'
```

## 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

9 entries across 9 versions & 2 rubygems

Version Path
htmlbeautifier-1.4.2 README.md
htmlbeautifier-1.4.1 README.md
htmlbeautifier-1.4.0 README.md
zine_brewer-1.5.0 vendor/bundle/ruby/2.7.0/gems/htmlbeautifier-1.3.1/README.md
zine_brewer-1.3.0 vendor/bundle/ruby/2.7.0/gems/htmlbeautifier-1.3.1/README.md
htmlbeautifier-1.3.1 README.md
htmlbeautifier-1.3.0 README.md
htmlbeautifier-1.2.1 README.md
htmlbeautifier-1.2.0 README.md