Skip to content

Commit ea3ed2e

Browse files
docs(all): add doctype for valid HTML in all documentation (#1868)
This adds the doctype to all HTML snippets in order to make sure the snippets are valid HTML.
1 parent 3252eb7 commit ea3ed2e

7 files changed

+18
-11
lines changed

src/content/guides/asset-management.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Let's make a minor change to our project before we get started:
2121
__dist/index.html__
2222

2323
``` diff
24+
<!doctype html>
2425
<html>
2526
<head>
2627
- <title>Getting Started</title>

src/content/guides/author-libraries.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,17 +101,18 @@ require(['webpackNumbers'], function ( webpackNumbers) {
101101
The consumer also can use the library by loading it via a script tag:
102102

103103
``` html
104+
<!doctype html>
104105
<html>
105-
...
106-
<script src="https://unpkg.com/webpack-numbers"></script>
107-
<script>
108-
// ...
109-
// Global variable
110-
webpackNumbers.wordToNum('Five')
111-
// Property in the window object
112-
window.webpackNumbers.wordToNum('Five')
113-
// ...
114-
</script>
106+
...
107+
<script src="https://unpkg.com/webpack-numbers"></script>
108+
<script>
109+
// ...
110+
// Global variable
111+
webpackNumbers.wordToNum('Five')
112+
// Property in the window object
113+
window.webpackNumbers.wordToNum('Five')
114+
// ...
115+
</script>
115116
</html>
116117
```
117118

src/content/guides/development-vagrant.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ module.exports = {
3636
And create a `index.html` file. The script tag should point to your bundle. If `output.filename` is not specified in the config, this will be `bundle.js`.
3737

3838
```html
39-
<!DOCTYPE html>
39+
<!doctype html>
4040
<html>
4141
<head>
4242
<script src="/bundle.js" charset="utf-8"></script>

src/content/guides/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ document.body.appendChild(component());
5858
__index.html__
5959

6060
``` html
61+
<!doctype html>
6162
<html>
6263
<head>
6364
<title>Getting Started</title>
@@ -127,6 +128,7 @@ Now, since we'll be bundling our scripts, we have to update our `index.html` fil
127128
__dist/index.html__
128129

129130
``` diff
131+
<!doctype html>
130132
<html>
131133
<head>
132134
<title>Getting Started</title>

src/content/guides/output-management.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ Let's also update our `dist/index.html` file, in preparation for webpack to spli
6969
__dist/index.html__
7070

7171
``` diff
72+
<!doctype html>
7273
<html>
7374
<head>
7475
- <title>Asset Management</title>

src/content/guides/shimming.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,7 @@ With that in place, we can add the logic to conditionally load our new `polyfill
374374
__dist/index.html__
375375

376376
``` diff
377+
<!doctype html>
377378
<html>
378379
<head>
379380
<title>Getting Started</title>

src/content/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ module.exports = {
4545
__page.html__
4646

4747
```html
48+
<!doctype html>
4849
<html>
4950
<head>
5051
...

0 commit comments

Comments
 (0)