Contents

## About

nanoc-tidy.rb is a
[nanoc](https://nanoc.app)
filter that integrates
[tidy-html5](https://github.com/htacg/tidy-html5)
into nanoc. <br>
The filter can format and validate HTML produced
during the
[nanoc](https://nanoc.app)
build process.

## Examples

__Defaults__

The following example executes tidy with the default settings. <br>
See [Nanoc::Tidy.default_argv](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_argv-class_method)
for more details:

``` ruby
# Rules
require "nanoc-tidy"
compile "/index.html.erb" do
  layout("/default.*")
  filter(:erb)
  filter(:tidy)
  write("/index.html")
end
```

__Option: argv__

The following example sets the "argv" filter option. <br>
The filter option is combined with
[Nanoc::Tidy.default_argv](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_argv-class_method):

```ruby
# Rules
require "nanoc-tidy"
compile "/index.html.erb" do
  layout("/default.*")
  filter(:erb)
  filter(:tidy, argv: ["-upper"])
  write("/index.html")
end
```

__Option: exe__

The "exe" option can be used to change the default executable
from "tidy5" to something else, the most common alternative
might be "tidy":

```ruby
# Rules
require "nanoc-tidy"
compile "/index.html.erb" do
  layout("/default.*")
  filter(:erb)
  filter(:tidy, exe: "tidy")
  write("/index.html")
end
```

## Install

**Rubygems.org**

nanoc-tidy.rb can be installed via rubygems.org:

    gem install nanoc-tidy.rb

## Sources

* [GitHub](https://github.com/0x1eef/nanoc-tidy.rb#readme)
* [GitLab](https://gitlab.com/0x1eef/nanoc-tidy.rb#about)

## License

[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
<br>
See [LICENSE](./LICENSE)

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
nanoc-tidy.rb-0.8.4	README.md
nanoc-tidy.rb-0.8.3	README.md
nanoc-tidy.rb-0.8.2	README.md
nanoc-tidy.rb-0.8.1	README.md