/nanoc-tidy.rb

nanoc-tidy.rb integrates tidy-html5 into nanoc.

Primary LanguageRubyBSD Zero Clause License0BSD

About

nanoc-tidy.rb is a nanoc filter that adds tidy-html5 support to nanoc.
The filter can format and validate HTML produced during the nanoc build process.

Examples

Defaults

The following example executes tidy with the default settings.
See Nanoc::Tidy.default_argv for more details:

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

Option: argv

The argv option forwards command line arguments directly to the tidy-html5 executable.
Nanoc::Tidy.default_argv returns the default command line arguments forwarded to tidy-html5:

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

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

Install

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

gem install nanoc-tidy.rb

Sources

License

BSD Zero Clause
See LICENSE