Logo HTMLHint
HTMLHint

The static code analysis tool you need for your HTML.

Travis Build Status Codecov NPM count MIT Licence Chat Chat

  How To Use • Contributing • Roadmap • Website

## Table of Contents - **[Installation and Usage](#-installation-and-usage)** - **[Local Installation and Usage](#local-installation-and-usage)** - **[Global Installation and Usage](#global-installation-and-usage)** - **[Example output](#-example-output)** - **[Configuration](#-configuration)** - **[Docs](#-docs)** ## 📟 Installation and Usage Prerequisites: Node.js (>=6.14), npm version 3+. 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 analyse 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`: ``` ... ``` ## 📙 Docs 1. [How to use](https://github.com/htmlhint/HTMLHint/wiki/Usage) 2. [All Rules](https://github.com/htmlhint/HTMLHint/wiki/Rules) 3. [How to Develop](https://github.com/htmlhint/HTMLHint/wiki/Developer-guide) ## © License [MIT License](./LICENSE.md) ## 💪🏻 Contributors This project exists thanks to all these people. [Contribute](CONTRIBUTING.md). ## 🏅 Backers Thank you to all our backers! [Become a backer](https://opencollective.com/htmlhint#backer). ## 🎖 Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/htmlhint#sponsor).