1
1
mirror of https://github.com/theoludwig/html-w3c-validator.git synced 2024-12-08 00:45:37 +01:00

docs: update description

This commit is contained in:
Théo LUDWIG 2024-02-02 15:44:03 +01:00
parent 8934ac1b7a
commit 92320385b5
Signed by: theoludwig
GPG Key ID: ADFE5A563D718F3B
3 changed files with 11 additions and 13 deletions

View File

@ -1,9 +1,7 @@
<h1 align="center">html-w3c-validator</h1>
<p align="center">
<strong>CLI for validating multiple html pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong>
</p>
<strong>CLI for validating HTML pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong>
</p>
<p align="center">
@ -22,11 +20,11 @@
## 📜 About
**html-w3c-validator** is a CLI tool to validate multiple html pages using [validator.w3.org](https://validator.w3.org/).
**html-w3c-validator** is a CLI tool to validate HTML pages using [validator.w3.org](https://validator.w3.org/).
You might use a JavaScript framework or simply use HTML but **you should always validate your production HTML** and this validation should be part of your CI/CD pipeline (tests, linting, etc.).
### Why should I validate my HTML pages?
### Why is HTML page validation important?
Quote from [https://validator.w3.org/docs/help.html#why-validate](https://validator.w3.org/docs/help.html#why-validate):
@ -52,21 +50,21 @@ npm install --save-dev html-w3c-validator start-server-and-test
### `package.json`
```json
```jsonc
{
"scripts": {
// Command to start the server serving your HTML pages (e.g: using vercel/serve)
"start": "serve \"./build\"",
// Command to validate your HTML pages
"test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\""
}
"test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\"",
},
}
```
### `.html-w3c-validatorrc.json`
```json
```jsonc
{
"$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/main/schema/html-w3c-validatorrc-schema.json",
@ -77,7 +75,7 @@ npm install --save-dev html-w3c-validator start-server-and-test
"files": ["./index.html", "./about.html"],
// Specify the severities of the validator messages to report. (default: ["warning", "error"])
"severities": ["info", "warning", "error"]
"severities": ["info", "warning", "error"],
}
```
@ -101,7 +99,7 @@ See the [./example](./example) folder for practical usage.
### Options
```text
--current-working-directory <path> The current working directory (default: process.cwd()).
--current-working-directory <path> The current working directory (default: `process.cwd()`).
-V, --version Output the version number.
-h, --help Display help for command.
```

View File

@ -1,7 +1,7 @@
{
"name": "html-w3c-validator",
"version": "0.0.0-development",
"description": "CLI for validating multiple html pages using validator.w3.org.",
"description": "CLI for validating HTML pages using validator.w3.org.",
"public": true,
"types": "module",
"type": "module",

View File

@ -48,7 +48,7 @@ const printResults = (results: Result[]): void => {
export class HTMLValidatorCommand extends Command {
static override usage = {
description:
"CLI for validating multiple html pages using <https://validator.w3.org/>.",
"CLI for validating HTML pages using <https://validator.w3.org/>.",
}
public currentWorkingDirectory = Option.String(