Skip to content

Commit 84994ac

Browse files
Merge branch 'master' into patch-1
2 parents e4e2c96 + 506ed10 commit 84994ac

File tree

175 files changed

+7111
-2778
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

175 files changed

+7111
-2778
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Contributing
22
------------
33

4-
From adding an issue for a documentation suggestion to creating a pull request: every
4+
From opening an issue for a documentation suggestion to creating a pull request: every
55
contribution is appreciated and welcome. If you're planning to implement a new section or
66
page please create an issue first.
77

88

99
## Setup
1010

11-
Start by ensuring you have Node installed and forking the repository:
11+
Start by ensuring that you have Node.js installed and forking the repository:
1212

1313
- Install [Node.js][1] if you have not already.
1414
- Fork the **webpack.js.org** repo from [the main repository][2].
@@ -30,7 +30,7 @@ See the `package.json` for the full list of `scripts`.
3030
3131
> Note that a __Python version between v2.5.0 and 3.0.0__ is required for the [proselint][12] dependency.
3232
33-
> Although __Yarn__ is not required to work with webpack docs, the core team is using it more extensively. If you prefer to use Yarn make sure you [got it installed][13] and run `yarn` to pull all dependencies, `yarn build` to build the project, or `yarn start` to start development server.
33+
> Although __Yarn__ is not required to work with webpack docs, the core team is using it more extensively. If you prefer to use Yarn make sure that you [get it installed][13] and run `yarn` to pull all dependencies, `yarn build` to build the project, or `yarn start` to start the development server.
3434
3535
> On Debian and Ubuntu operating systems you may have to use `node >= 7.0.0` to avoid build errors with `node-sass`. Please note that we don't officially support building on these systems.
3636

.github/FUNDING.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
open_collective: webpack
2+

.github/ISSUE_TEMPLATE/Documentation_request.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@ name: Documentation request
33
about: Create a documentation request for a new feature or functionality change.
44
---
55

6-
**Feature to document**
6+
__Feature to document__
77

88
<!-- Name of the feature(s) and a link to related pull request of the feature implementation. -->
99

10-
**Author(s)**
10+
__Author(s)__
1111

1212
<!-- Mention feature author(s) in order to know who is assignable for review outside of the documentation team. -->
1313

14-
**Additional information**
14+
__Additional information__
1515

1616
<!-- Please provide any additional information that is required in order to document the feature in the best possible way or say N/A if linked PR has more than enough details. -->
17+
18+
[ ] I am willing to work on this issue and submit a pull request.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ _describe your changes..._
77

88

99
[1]: https://cla.js.foundation/webpack/webpack.js.org
10-
[2]: https://webpack.js.org/writers-guide/
10+
[2]: https://webpack.js.org/contribute/writers-guide/

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@ npm-debug.log
99
yarn-error.log
1010
package-lock.json
1111
.cache
12-
internal-links.tap
12+
internal-links.tap
13+
stats.json
14+
printable.md

README.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
# webpack.js.org
1+
<div align="center">
2+
<a href="https://github.com/webpack/webpack">
3+
<img width="200" height="200" src="https://webpack.js.org/assets/icon-square-big.svg">
4+
</a>
5+
<h1>webpack.js.org</h1>
26

3-
[![Build Status][13]][10]
4-
[![Standard Version][12]][11]
5-
6-
Guides, documentation, and all things webpack.
7+
[![Build Status][build-status]][build-status-url]
8+
[![Standard Version][release]][release-url]
9+
[![chat on gitter][chat]][chat-url]
10+
11+
Guides, documentation, and all things webpack.
12+
</div>
713

814

915
## Content Progress
@@ -13,49 +19,48 @@ starting to heavily review each section of the site's content to sort and
1319
structure it appropriately. The following issues should provide a pretty good
1420
idea of where things are, and where they are going:
1521

16-
- [Guides - Review and Simplify][1]
17-
- [Concepts - Review and Organize][2]
18-
- [API - v4 Rewrite][8]
22+
- [Guides - Review and Simplify][guides-url]
23+
- [Concepts - Review and Organize][concepts-url]
1924

2025
We haven't created issues for the other sections yet, but they will be coming
21-
soon. For dev-related work please see [General - Updates & Fixes][3].
26+
soon. For dev-related work please see [General - Updates & Fixes][general-url].
2227

28+
The alpha version of webpack 5 is out and we are lagging behind with documenting all of the related changes. See [this refined search][webpack5-milestone-url] for the list of relevant documentation requests.
2329

2430
## Translation
2531

26-
To help translate this documentation please jump to the [translate branch][4].
27-
32+
To help translate this documentation please jump to the [translation branch][translate-url].
2833

2934
## Contributing
3035

31-
Read through the [writer's guide][7] if you're interested in editing the
32-
content on this site. See the [contributors page][5] to learn how to set up and
36+
Read through the [writer's guide][writer-guide-url] if you're interested in editing the
37+
content on this site. See the [contributors page][contributing-url] to learn how to set up and
3338
start working on the site locally.
3439

35-
3640
## License
3741

38-
The content is available under the [Creative Commons BY 4.0][6] license.
39-
42+
The content is available under the [Creative Commons BY 4.0][license-url] license.
4043

4144
## Special Thanks
4245

4346
_BrowserStack_ has graciously allowed us to do cross-browser and cross-os
4447
testing of the site at no cost...
4548

46-
[![BrowserStackLogo](./browserstack-logo.png)][9]
47-
48-
49-
[1]: https://github.com/webpack/webpack.js.org/issues/1258
50-
[2]: https://github.com/webpack/webpack.js.org/issues/1386
51-
[3]: https://github.com/webpack/webpack.js.org/issues/1525
52-
[4]: https://github.com/webpack/webpack.js.org/tree/translation
53-
[5]: https://github.com/webpack/webpack.js.org/blob/master/.github/CONTRIBUTING.md
54-
[6]: https://creativecommons.org/licenses/by/4.0/
55-
[7]: https://webpack.js.org/writers-guide
56-
[8]: https://github.com/webpack/webpack.js.org/pull/1754
57-
[9]: http://browserstack.com/
58-
[10]: http://travis-ci.org/webpack/webpack.js.org
59-
[11]: https://github.com/conventional-changelog/standard-version
60-
[12]: https://img.shields.io/badge/release-standard%20version-brightgreen.svg
61-
[13]: https://secure.travis-ci.org/webpack/webpack.js.org.svg
49+
[![BrowserStackLogo][browserstack]][browserstack-url]
50+
51+
[webpack5-milestone-url]: https://github.com/webpack/webpack.js.org/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22webpack+5%22
52+
[build-status]: https://secure.travis-ci.org/webpack/webpack.js.org.svg
53+
[build-status-url]: http://travis-ci.org/webpack/webpack.js.org
54+
[browserstack]: ./browserstack-logo.png
55+
[browserstack-url]: http://browserstack.com/
56+
[chat]: https://badges.gitter.im/webpack/webpack.svg
57+
[chat-url]: https://gitter.im/webpack/webpack
58+
[concepts-url]: https://github.com/webpack/webpack.js.org/issues/1386
59+
[contributing-url]: https://github.com/webpack/webpack.js.org/blob/master/.github/CONTRIBUTING.md
60+
[general-url]: https://github.com/webpack/webpack.js.org/issues/1525
61+
[guides-url]: https://github.com/webpack/webpack.js.org/issues/1258
62+
[license-url]: https://creativecommons.org/licenses/by/4.0/
63+
[release]: https://img.shields.io/badge/release-standard%20version-brightgreen.svg
64+
[release-url]: https://github.com/conventional-changelog/standard-version
65+
[translate-url]: https://github.com/webpack/webpack.js.org/tree/translation
66+
[writer-guide-url]: https://webpack.js.org/contribute/writers-guide

package.json

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,29 +24,34 @@
2424
"node": ">=8.9.4"
2525
},
2626
"scripts": {
27-
"clean": "rimraf ./dist src/content/**/_*.md src/**/_*.json",
28-
"start": "cross-env NODE_ENV=development webpack-dev-server --config webpack.dev.js --env.dev",
27+
"clean-dist": "rimraf ./dist",
28+
"clean-printable": "rimraf src/content/**/printable.md",
29+
"preclean": "run-s clean-dist clean-printable",
30+
"clean": "rimraf src/content/**/_*.md src/**/_*.json",
31+
"start": "npm run clean-dist && cross-env NODE_ENV=development webpack-dev-server --config webpack.dev.js --env.dev",
2932
"update-repos": "node src/utilities/fetch-package-repos.js",
3033
"content": "node src/scripts/build-content-tree.js ./src/content ./src/_content.json",
31-
"build-test": "npm run build && http-server dist/",
34+
"bundle-analyze": "run-s clean fetch printable content && cross-env NODE_ENV=production webpack --config webpack.ssg.js && run-s clean-printable content && cross-env NODE_ENV=production webpack --config webpack.prod.js --profile --json > stats.json && webpack-bundle-analyzer stats.json",
3235
"fetch": "run-p fetch:*",
3336
"fetch:readmes": "node src/utilities/fetch-package-readmes.js",
3437
"fetch:supporters": "node src/utilities/fetch-supporters.js",
3538
"fetch:starter-kits": "node src/utilities/fetch-starter-kits.js",
3639
"prebuild": "npm run clean",
37-
"build": "run-s fetch content && cross-env NODE_ENV=production webpack --config webpack.prod.js",
38-
"postbuild": "npm run sitemap",
40+
"build": "run-s fetch printable content && cross-env NODE_ENV=production webpack --config webpack.ssg.js && run-s clean-printable content && cross-env NODE_ENV=production webpack --config webpack.prod.js",
41+
"postbuild": "bundlesize && npm run sitemap",
42+
"build-test": "npm run build && http-server dist/",
3943
"test": "npm run lint",
4044
"lint": "run-s lint:*",
4145
"lint:js": "eslint src --ext .js,.jsx,.md --cache true --cache-location .cache/.eslintcache",
4246
"lint:markdown": "markdownlint --rules markdownlint-rule-emphasis-style --config ./.markdownlint.json *.md ./src/content/**/*.md --ignore './src/content/**/_*.md'",
4347
"lint:social": "alex . -q",
4448
"lint:prose": "cp .proselintrc ~/ && proselint src/content",
45-
"lint:links": "hyperlink -r dist/index.html --canonicalroot https://webpack.js.org/ -i --todo https://img.shields.io --todo https://codecov.io/gh --todo 'content-type-mismatch https://travis-ci.org' --todo 'Asset is used as both Html and Image' | tee internal-links.tap | tap-spot",
46-
"linkcheck": "hyperlink -r dist/index.html --canonicalroot https://webpack.js.org/ --skip support__ --skip sidecar.gitter.im --skip vimdoc.sourceforge.net --skip img.shields.io --skip npmjs.com/package/ --skip opencollective.com/webpack --todo external-redirect | tee external-links.tap | tap-spot",
47-
"sitemap": "cd dist && sitemap-static --prefix=https://webpack.js.org/ > sitemap.xml",
49+
"lint:links": "hyperlink -c 8 -r dist/index.html --canonicalroot https://webpack.js.org/ -i --skip https://img.shields.io --skip https://codecov.io/gh --skip 'content-type-mismatch https://travis-ci.org' > internal-links.tap; cat internal-links.tap | tap-spot",
50+
"sitemap": "cd dist && sitemap-static --ignore-file=../sitemap-ignore.json --pretty --prefix=https://webpack.js.org/ > sitemap.xml",
4851
"serve": "npm run build && sirv start ./dist --port 4000",
49-
"deploy": "gh-pages -d dist"
52+
"deploy": "gh-pages -d dist",
53+
"preprintable": "npm run clean-printable",
54+
"printable": "node ./src/scripts/concatenate-docs.js"
5055
},
5156
"husky": {
5257
"hooks": {
@@ -61,10 +66,16 @@
6166
"npm run lint:markdown"
6267
]
6368
},
69+
"bundlesize": [
70+
{
71+
"path": "./dist/index.bundle.js",
72+
"maxSize": "200 kB"
73+
}
74+
],
6475
"devDependencies": {
6576
"@mdx-js/loader": "0.15.7",
6677
"@mdx-js/mdx": "0.15.7",
67-
"@octokit/rest": "^15.9.4",
78+
"@octokit/rest": "^16.27.1",
6879
"alex": "^5.1.0",
6980
"autoprefixer": "^7.2.3",
7081
"babel-core": "^6.26.0",
@@ -75,6 +86,7 @@
7586
"babel-plugin-transform-object-rest-spread": "^6.26.0",
7687
"babel-preset-env": "^1.6.0",
7788
"babel-preset-react": "^6.24.1",
89+
"bundlesize": "^0.17.1",
7890
"copy-webpack-plugin": "4.5.2",
7991
"cross-env": "5.2.0",
8092
"css-loader": "^0.28.10",
@@ -92,66 +104,68 @@
92104
"html-webpack-template": "^6.1.0",
93105
"http-server": "^0.10.0",
94106
"husky": "^1.0.0-rc.8",
95-
"hyperlink": "^4.0.0",
107+
"hyperlink": "^4.4.0",
96108
"lint-staged": "^8.1.0",
97109
"loader-utils": "^1.1.0",
98110
"lodash": "^4.17.4",
99111
"markdown-loader": "^4.0.0",
100112
"markdownlint": "^0.11.0",
101113
"markdownlint-cli": "^0.13.0",
102114
"markdownlint-rule-emphasis-style": "^1.0.0",
103-
"marked": "^0.5.2",
104-
"mermaid.cli": "^0.3.6",
115+
"marked": "0.6.1",
105116
"mini-css-extract-plugin": "^0.5.0",
106117
"minimist": "1.2.0",
107118
"mkdirp": "^0.5.1",
108119
"modularscale-sass": "^3.0.3",
109120
"node-sass": "^4.5.3",
110121
"npm-run-all": "^4.1.1",
122+
"offline-plugin": "^5.0.7",
123+
"optimize-css-assets-webpack-plugin": "^5.0.1",
111124
"postcss-loader": "^2.1.3",
112125
"redirect-webpack-plugin": "^0.1.1",
113126
"remark": "^10.0.1",
114-
"remark-autolink-headings": "^5.0.0",
127+
"remark-autolink-headings": "5.2.1",
115128
"remark-custom-blockquotes": "1.0.0",
116-
"remark-extract-anchors": "1.0.0",
129+
"remark-extract-anchors": "1.0.2",
117130
"remark-loader": "^0.3.0",
118-
"remark-mermaid": "^0.2.0",
119131
"remark-refractor": "1.1.0",
120132
"remark-responsive-tables": "1.0.0",
121133
"remark-slug": "^5.0.0",
122-
"request": "^2.81.0",
123-
"request-promise": "^4.2.2",
134+
"request-promise": "4.2.4",
124135
"rimraf": "^2.6.2",
125136
"sass-loader": "^6.0.6",
126137
"sirv-cli": "^0.1.2",
127138
"sitemap-static": "^0.4.2",
128139
"static-site-generator-webpack-plugin": "^3.4.1",
129140
"style-loader": "^0.18.2",
130141
"tap-spot": "^1.1.1",
142+
"terser-webpack-plugin": "^1.2.3",
131143
"through2": "^2.0.3",
132144
"uglifyjs-webpack-plugin": "^1.1.6",
133-
"webpack": "^4.29.6",
145+
"webpack": "^4.30.0",
146+
"webpack-bundle-analyzer": "^3.3.2",
134147
"webpack-cli": "^3.2.3",
135148
"webpack-dev-server": "^3.2.1",
136149
"webpack-merge": "^4.1.0"
137150
},
138151
"dependencies": {
139-
"@rigor789/remark-autolink-headings": "^5.1.0",
140152
"ajv": "^5.5.2",
141153
"docsearch.js": "^2.5.2",
142154
"gitter-sidecar": "^1.2.3",
143155
"javascriptstuff-db": "^1.12.0",
144156
"lodash.throttle": "^4.1.1",
145-
"prop-types": "^15.5.10",
146-
"react": "^16.2.0",
157+
"prop-types": "^15.7.2",
158+
"react": "^16.8.6",
147159
"react-banner": "^1.0.0-rc.0",
148160
"react-document-title": "^2.0.3",
149-
"react-dom": "^16.2.0",
161+
"react-dom": "^16.8.6",
150162
"react-g-analytics": "0.4.2",
151163
"react-hot-loader": "^4.0.0-beta.12",
152-
"react-markdown": "4.0.4",
164+
"react-markdown": "4.2.2",
153165
"react-router-dom": "^4.2.2",
154166
"react-tiny-popover": "3.4.2",
167+
"react-visibility-sensor": "^5.0.2",
168+
"webpack-pwa-manifest": "^4.0.0",
155169
"webpack.vote": "^0.1.2",
156170
"whatwg-fetch": "^2.0.3"
157171
}

repositories/loaders.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
"webpack-contrib/cache-loader",
3838
"webpack-contrib/thread-loader",
3939
"webpack-contrib/polymer-webpack-loader",
40-
"webpack-contrib/config-loader",
4140
"babel/babel-loader",
4241
"postcss/postcss-loader",
4342
"peerigon/extract-loader"

repositories/plugins.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[
22
"webpack-contrib/i18n-webpack-plugin",
3-
"webpack-contrib/component-webpack-plugin",
43
"webpack-contrib/compression-webpack-plugin",
54
"webpack-contrib/extract-text-webpack-plugin",
65
"webpack-contrib/copy-webpack-plugin",

sitemap-ignore.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[
2+
"app-shell/index.html",
3+
"appcache/manifest.html"
4+
]

src/assets/icon-print.svg

Lines changed: 1 addition & 0 deletions
Loading

src/assets/icon-pwa-512x512.png

9.71 KB
Loading

src/assets/robots.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
User-agent: *
2+
Disallow: /**/printable/

0 commit comments

Comments
 (0)