UNPKG

htmllint/README.md

Version:

2.11 kBMarkdownView Raw

1# htmllint [![npm version](http://img.shields.io/npm/v/htmllint.svg?style=flat-square)](https://npmjs.org/package/htmllint) [![license](http://img.shields.io/npm/l/htmllint.svg?style=flat-square)](https://npmjs.org/package/htmllint) [![build status](http://img.shields.io/travis/htmllint/htmllint/master.svg?style=flat-square)](https://travis-ci.org/htmllint/htmllint) [![coveralls](http://img.shields.io/coveralls/htmllint/htmllint.svg?style=flat-square)](https://coveralls.io/r/htmllint/htmllint)
2
3[![stories in ready](https://badge.waffle.io/htmllint/htmllint.svg?label=ready&title=Ready)](http://waffle.io/htmllint/htmllint)
4[![dependencies](http://img.shields.io/david/htmllint/htmllint.svg?style=flat-square)](https://david-dm.org/htmllint/htmllint)
5[![devDependencies](http://img.shields.io/david/dev/htmllint/htmllint.svg?style=flat-square)](https://david-dm.org/htmllint/htmllint)
6
7> An unofficial html5 linter and validator.
8
9htmllint uses a parser to get the DOM for your html. It then runs uses the provided rules (and default rules) to lint both the DOM and then individual lines. [Take a look at the supported options](https://github.com/htmllint/htmllint/wiki/Options).
10
11Getting Started
12---------------
13
14You can use htmllint in Node.JS by using   
15```
16require('htmllint')  
17```
18in your code, and doing an install with  
19```
20npm install htmllint
21```
22(Remember `--save-dev` if this is just for your development).  
23
24### Now What?
25
26To learn more about the options and usage of htmllint, check out the
27[user manual](https://github.com/htmllint/htmllint/wiki/htmllint-manual).
28  
29Other Interfaces
30----------------
31
32This module doesn't provide any cli interface on its own. It's highly recommended that
33you use one of the following modules to run the linter:
34* [`grunt-htmllint`](https://github.com/htmllint/grunt-htmllint): a grunt plugin for htmllint
35* [`htmllint-cli`](https://github.com/htmllint/htmllint-cli): a cli interface for htmllint (NOTE: not complete at the moment)
36
37[![npm](https://nodei.co/npm/htmllint.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/package/htmllint)

1	`# htmllint [![npm version](http://img.shields.io/npm/v/htmllint.svg?style=flat-square)](https://npmjs.org/package/htmllint) [![license](http://img.shields.io/npm/l/htmllint.svg?style=flat-square)](https://npmjs.org/package/htmllint) [![build status](http://img.shields.io/travis/htmllint/htmllint/master.svg?style=flat-square)](https://travis-ci.org/htmllint/htmllint) [![coveralls](http://img.shields.io/coveralls/htmllint/htmllint.svg?style=flat-square)](https://coveralls.io/r/htmllint/htmllint)`
2
3	`[![stories in ready](https://badge.waffle.io/htmllint/htmllint.svg?label=ready&title=Ready)](http://waffle.io/htmllint/htmllint)`
4	`[![dependencies](http://img.shields.io/david/htmllint/htmllint.svg?style=flat-square)](https://david-dm.org/htmllint/htmllint)`
5	`[![devDependencies](http://img.shields.io/david/dev/htmllint/htmllint.svg?style=flat-square)](https://david-dm.org/htmllint/htmllint)`
6
7	`> An unofficial html5 linter and validator.`
8
9	`htmllint uses a parser to get the DOM for your html. It then runs uses the provided rules (and default rules) to lint both the DOM and then individual lines. [Take a look at the supported options](https://github.com/htmllint/htmllint/wiki/Options).`
10
11	`Getting Started`
12	`---------------`
13
14	`You can use htmllint in Node.JS by using`
15	```
16	`require('htmllint')`
17	```
18	`in your code, and doing an install with`
19	```
20	`npm install htmllint`
21	```
22	(Remember `--save-dev` if this is just for your development).
23
24	`### Now What?`
25
26	`To learn more about the options and usage of htmllint, check out the`
27	`[user manual](https://github.com/htmllint/htmllint/wiki/htmllint-manual).`
28
29	`Other Interfaces`
30	`----------------`
31
32	`This module doesn't provide any cli interface on its own. It's highly recommended that`
33	`you use one of the following modules to run the linter:`
34	* [`grunt-htmllint`](https://github.com/htmllint/grunt-htmllint): a grunt plugin for htmllint
35	* [`htmllint-cli`](https://github.com/htmllint/htmllint-cli): a cli interface for htmllint (NOTE: not complete at the moment)
36
37	`[![npm](https://nodei.co/npm/htmllint.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/package/htmllint)`