htmlhint

The Static Code Analysis Tool for your HTML

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
htmlhint
1.1.42 years ago11 years agoMinified + gzip package size for htmlhint in KB

Popular Searches

Readme


Logo HTMLHint
HTMLHint

The static code analysis tool you need for your HTML.


<img src="https://img.shields.io/travis/htmlhint/HTMLHint.svg" alt="Travis Build Status">
<img src="https://codecov.io/gh/htmlhint/HTMLHint/branch/master/graph/badge.svg" alt="Codecov">
 
<img src="https://img.shields.io/npm/dm/htmlhint.svg" alt="NPM count">
 MIT License 
<img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat">


Ā  How To Use ā€¢ Contributing ā€¢ Website

Table of Contents

- Local Installation and Usage - Global Installation and UsageConfiguration
  • 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:
    <!--htmlhint tag-pair,id-class-value:underline -->
<html>
<head>
...

    šŸ“™ 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.

    šŸ… Backers

    Thank you to all our backers! Become a backer.

    šŸŽ– Sponsors

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