Home

Awesome

<h1 align="center"> <br> <a href="https://htmlhint.com"><img src="https://raw.githubusercontent.com/htmlhint/HTMLHint/master/website/static/img/htmlhint.png" alt="Logo HTMLHint" width="170"></a> <br> HTMLHint <br> </h1> <h4 align="center">The static code analysis tool you need for your HTML.</h4> <p align="center"> <a href="https://travis-ci.org/htmlhint/HTMLHint"> <img src="https://img.shields.io/travis/htmlhint/HTMLHint.svg" alt="Travis Build Status"> </a> <a href="https://codecov.io/gh/htmlhint/HTMLHint"> <img src="https://codecov.io/gh/htmlhint/HTMLHint/branch/master/graph/badge.svg" alt="Codecov"> </a> <a href="https://www.npmjs.com/package/htmlhint"> <img src="https://img.shields.io/npm/dm/htmlhint.svg" alt="npm count"> </a> <img src="https://badgen.net/badge/license/MIT/green" alt="MIT License" /> </p> <p align="center"> Ā  <a href="#-installation-and-usage">How To Use</a> ā€¢ <a href="#contributing">Contributing</a> ā€¢ <a href="https://htmlhint.com">Website</a> </p>

Table of Contents

šŸ“Ÿ Installation and Usage

There are two ways to install HTMLHint: globally and locally.

Local Installation and Usage

In case you want to include HTMLHint as part of your project, you can install it locally using npm:

$ npm install htmlhint --save-dev

After that, You can run HTMLHint on any file or directory like this:

$ ./node_modules/.bin/htmlhint www/index.html
$ ./node_modules/.bin/htmlhint www/**/*.html

Global Installation and Usage

If you want to make HTMLHint available to tools that run across all of your projects, you can install HTMLHint globally using npm:

$ npm install htmlhint -g

After that, you can run HTMLHint on any file like this:

$ htmlhint www/index.html
$ htmlhint www/**/*.html

You can even launch HTMLHint to analyze an URL:

$ htmlhint https://htmlhint.com/

šŸ“ƒ Example output

šŸ”§ Configuration

Search .htmlhintrc file in current directory and all parent directories:

$ htmlhint
$ htmlhint test.html

Custom config file:

$ htmlhint --config htmlhint.conf test.html

Custom rules:

$ htmlhint --rules tag-pair,id-class-value=underline index.html

Inline rules in test.html:

<!--htmlhint tag-pair,id-class-value:underline -->
<html>
  <head>
    ...
  </head>
</html>

šŸ“™ Docs

  1. How to use
  2. All Rules
  3. How to Develop

Ā© License

MIT License

šŸ’ŖšŸ» Contributors

This project exists thanks to all these people. Contribute. <a href="https://github.com/htmlhint/HTMLHint/graphs/contributors"><img src="https://opencollective.com/htmlhint/contributors.svg?width=890" /></a>

šŸ… Backers

Thank you to all our backers! Become a backer.

<a href="https://opencollective.com/htmlhint#backers" target="_blank"><img src="https://opencollective.com/htmlhint/backers.svg?width=890"></a>

šŸŽ– Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor.

<a href="https://opencollective.com/htmlhint/sponsor/0/website" target="_blank"><img src="https://opencollective.com/htmlhint/sponsor/0/avatar.svg"></a>