Skip to content
This repository was archived by the owner on Feb 1, 2022. It is now read-only.

Commit e6c2243

Browse files
committed
add "What's Bootlint?" section to README
Refs #28
1 parent 991152a commit e6c2243

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,15 @@
44
[![Dependency Status](https://david-dm.org/cvrebert/bootlint.svg)](https://david-dm.org/cvrebert/bootlint)
55
[![devDependency Status](https://david-dm.org/cvrebert/bootlint/dev-status.svg)](https://david-dm.org/cvrebert/bootlint#info=devDependencies)
66

7-
HTML linter for Bootstrap projects
7+
An HTML [linter](http://en.wikipedia.org/wiki/Lint_(software)) for [Bootstrap](http://getbootstrap.com) projects
8+
9+
## What's Bootlint?
10+
Bootlint is a tool that checks for several common HTML mistakes in webpages that are using [Bootstrap](http://getbootstrap.com) in a fairly "vanilla" way. Vanilla Bootstrap's components/widgets require their parts of the DOM to conform to certain structures. Bootlint checks that instances of Bootstrap components have correctly-structured HTML. Optimal usage of Bootstrap also requires that your pages include certain `<meta>` tags, an HTML5 doctype declaration, etc.; Bootlint checks that these are present.
11+
12+
### Caveats
13+
Bootlint assumes that your webpage is already valid HTML5. If you need to check HTML5 validity, we recommend tools like [`vnu.jar`](https://github.com/validator/validator.github.io), [grunt-html](https://www.npmjs.org/package/grunt-html), or [grunt-html-validation](https://www.npmjs.org/package/grunt-html-validation).
14+
15+
Bootlint assumes that you are using Bootstrap's default class names in your webpage, as opposed to taking advantage of the "mixins" functionality of Less or Sass to map them to custom class names. If you are using mixins, Bootlint may report some false-positive warnings. However, there are some Bootlint checks that are applicable even if you are using mixins pervasively.
816

917
## Getting Started
1018
### On the command line
@@ -29,11 +37,9 @@ In your webpage:
2937
Then check the JavaScript console for lint warning messages.
3038

3139
## API Documentation
32-
3340
Bootlint is a CommonJS module.
3441

3542
### Browser
36-
3743
Bootlint exports a `bootlint` property on the global `window` object.
3844
In a browser environment, the following public APIs are available:
3945

0 commit comments

Comments
 (0)