You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-12Lines changed: 17 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,28 +5,24 @@
5
5
6
6
# html-validate-webpack-plugin
7
7
8
-
> An [html-validate.org](https://html-validate.org/)webpack plugin
8
+
> An [html-validate.org](https://html-validate.org/) plugin for webpack
9
9
10
10
## About plugin
11
11
12
-
This plugin is a simple wrapper around the [html-validate.org](https://html-validate.org/) cli.
13
-
14
-
Validate your html automatically after each webpack compilation; similarly to how you would use eslint and stylelint.
12
+
This plugin is a simple wrapper around the [html-validate.org](https://html-validate.org/) cli for automatic validation after each webpack compilation.
**Note**: Install `html-validate`if you haven't already.
20
+
**Note**: Install `html-validate`and create a `.htmlvalidate.json` at the project root with your [configurations](https://html-validate.org/usage/index.html).
23
21
24
22
```bash
25
23
npm install html-validate --save-dev
26
24
```
27
25
28
-
**Note**: Create a `.htmlvalidate.json` file with your configurations. [See this page for instructions](https://html-validate.org/usage/index.html).
29
-
30
26
## Usage
31
27
32
28
In your webpack configuration (development builds):
You can pass [html-validate.org](https://html-validate.org/) cli options.
46
+
You can pass select [html-validate.org](https://html-validate.org/) cli options.
47
47
48
48
### `path`
49
49
50
50
- Type: `String`
51
-
- Default: `src/**/*`
51
+
- Default: `'src/**/*'`
52
52
53
53
Specifies the directories/files for html-validate to search.
54
54
@@ -62,7 +62,7 @@ Specifies the file extensions to use when searching for files in directories.
62
62
### `config`
63
63
64
64
- Type: `String`
65
-
- Default: `.htmlvalidate.json`
65
+
- Default: `'.htmlvalidate.json'`
66
66
67
67
Specify a different configuration file.
68
68
@@ -75,7 +75,12 @@ Specify a different configuration file.
75
75
76
76
Specify the run context of html-validate.
77
77
78
-
**Note:** If you installed html-validate globally, set the value to `true`.
78
+
**Note:** If you installed `html-validate` globally, set the value to `true`.
79
+
80
+
## Features
81
+
82
+
-`html-validate`[performs all validation locally](https://html-validate.org/#offline) which means you can use `html-validate` and `html-validate-webpack-plugin` offline.
83
+
-`html-validate-webpack-plugin` has no dependencies.
0 commit comments