Skip to content

Commit 4199d54

Browse files
authored
chore: add icons and improvements (#2)
1 parent f9be576 commit 4199d54

File tree

8 files changed

+28
-5
lines changed

8 files changed

+28
-5
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![@nuxtjs/html-validator](https://html-validator.nuxtjs.org/preview.png)](https://html-validator.nuxtjs.org)
2+
13
# @nuxtjs/html-validator
24

35
[![npm version][npm-version-src]][npm-version-href]

docs/content/en/index.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Introduction
3-
description: ''
3+
description: 'Automatically validate Nuxt server-rendered HTML (SSR and SSG) to detect common issues with HTML that can lead to hydration errors, as well as improve accessibility and best practice.'
44
category: Getting started
55
items:
66
- Zero-configuration required
@@ -9,6 +9,9 @@ items:
99

1010
---
1111

12+
<img src="/preview.png" class="light-img" />
13+
<img src="/preview-dark.png" class="dark-img" />
14+
1215
## Key features
1316

1417
<list :items="items"></list>
@@ -23,14 +26,14 @@ This module configures [`html-validate`](https://html-validate.org/) to automati
2326
<code-block label="Yarn" active>
2427

2528
```bash
26-
yarn add @nuxtjs/html-validator
29+
yarn add @nuxtjs/html-validator --dev
2730
```
2831

2932
</code-block>
3033
<code-block label="NPM">
3134

3235
```bash
33-
npm install @nuxtjs/html-validator --save
36+
npm install @nuxtjs/html-validator --save-dev
3437
```
3538

3639
</code-block>
@@ -53,6 +56,7 @@ This module configures [`html-validate`](https://html-validate.org/) to automati
5356

5457
```js{}[nuxt.config.js]
5558
{
59+
// Install @nuxtjs/html-validator as dependency instead of devDependency
5660
modules: ['@nuxtjs/html-validator']
5761
}
5862
```

docs/content/settings.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
{
22
"title": "@nuxtjs/html-validator",
3-
"url": "https://github.com/nuxt-community/html-validator-module",
4-
"github": "nuxt-community/html-validator-module"
3+
"github": "nuxt-community/html-validator-module",
4+
"url": "https://html-validator.nuxtjs.org",
5+
"logo": {
6+
"light": "/logo-light.svg",
7+
"dark": "/logo-dark.svg"
8+
},
9+
"layout": "single"
510
}

docs/static/icon.png

7.89 KB
Loading

docs/static/logo-dark.svg

Lines changed: 6 additions & 0 deletions
Loading

docs/static/logo-light.svg

Lines changed: 6 additions & 0 deletions
Loading

docs/static/preview-dark.png

29.5 KB
Loading

docs/static/preview.png

25.3 KB
Loading

0 commit comments

Comments
 (0)