Skip to content

Commit 4b4e8ef

Browse files
committed
update readme
1 parent 322856a commit 4b4e8ef

File tree

1 file changed

+6
-20
lines changed

1 file changed

+6
-20
lines changed

README.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,14 @@ npm install html-validate-webpack-plugin --save-dev
2525
npm install html-validate --save-dev
2626
```
2727

28-
Or globally:
29-
30-
```bash
31-
npm install html-validate -g
32-
```
33-
34-
**Note**: Make sure you have created a `.htmlvalidate.json` file with your configurations. [See this page for instructions](https://html-validate.org/usage/index.html).
28+
**Note**: Create a `.htmlvalidate.json` file with your configurations. [See this page for instructions](https://html-validate.org/usage/index.html).
3529

3630
## Usage
3731

3832
In your webpack configuration (development builds):
3933

4034
```js
41-
const HtmlValidatePlugin = require("html-validate-webpack-plugin");
35+
const HtmlValidatePlugin = require('html-validate-webpack-plugin');
4236

4337
module.exports = {
4438
// ...
@@ -58,38 +52,30 @@ You can pass [html-validate.org](https://html-validate.org/) cli options.
5852

5953
Specifies the directories/files for html-validate to search.
6054

61-
Examples:
62-
63-
- A single file: `src/**/index`
64-
6555
### `extensions`
6656

6757
- Type: `array`
6858
- Default: `['html']`
6959

7060
Specifies the file extensions to use when searching for files in directories.
7161

72-
Examples:
73-
74-
- Multiple extensions: `['html', 'ejs']`
75-
7662
### `config`
7763

7864
- Type: `String`
7965
- Default: `.htmlvalidate.json`
8066

8167
Specify a different configuration file.
8268

83-
Examples:
84-
85-
- Your custom configuration: `'myconfig'` (omit the `.json` extension)
69+
**Note:** For your custom configuration omit the `.json` extension and supply the name only.
8670

8771
### `global`
8872

8973
- Type: `boolean`
9074
- Default: `false`
9175

92-
Specify the run context of html-validate. If you installed html-validate globally, set the value to `true`.
76+
Specify the run context of html-validate.
77+
78+
**Note:** If you installed html-validate globally, set the value to `true`.
9379

9480
## Contributing
9581

0 commit comments

Comments
 (0)