grunt-htmltidy

Tidy HTML using htmltidy.

Getting Started

This plugin requires Grunt >=0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-htmltidy --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-htmltidy');

The "htmltidy" task

Run this task with the grunt htmltidy command.

Tidies HTML using htmltidy. Bugs regarding the output should be reported here.

Overview

In your project's Gruntfile, add a section named htmltidy to the data object passed into grunt.initConfig().

grunt.initConfig({
  htmltidy: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Examples

You can tidy multiple HTML files with the one target using Grunt's files array syntax:

grunt.initConfig({
  htmltidy: {
    tidyMultiple: {
      files: [{
        expand: true,
        cwd: 'input/path',
        src: '**/*.html',
        dest: 'output/path'
      }]
    }
  }
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

Refer to the change log for a full list of changes.

Task submitted by Gavin Ballard Thanks to Sindre Sorhus