Skip to content

Commit

Permalink
Merge branch 'master' into cn (#433)
Browse files Browse the repository at this point in the history
* update /content/loaders & /content/plugins

* update /content/loaders & /content/plugins

* update /content/loaders & /content/plugins

* update contributors

* update /content/loaders & /content/plugins

* fix LinkDropdown

* 修复 npm 命令错误导致编译不成功的问题

* update /content/loaders & /content/plugins

* update /content/loaders & /content/plugins

* update /content/loaders & /content/plugins

* docs(plugins): fix typo in module-concatenation-plugin.md (#1683)

* docs(concepts): simplify the introduction (#1673)

Make the `index` page more beginner friendly with less technical
lingo and complex details.

Resolves #1416

* docs(plugins): add “scope hoisting” intro in module-concatenation-plugin (#1684)

This adds a link between “concatenation behavior” and “scope hoisting”. Without this, 
a new person might be confused what exactly “scope hoisting” is (because it appears 
without any visible connection to the previous content).

* docs(api): fix some method signatures in loaders.md (#1685)

In actual fact the parameters passed to `emitWarning` / `emitError` must 
be an instance of Error.

* update /content/loaders & /content/plugins

* docs(guides): consistent quoute use in typescript.md (#1687)

* docs(api/guides): document new --concatenate-modules flag (#1686)

Document the new `--concatenate-modules` flag in both the CLI documentation
and production guide. Add section on the `ModuleConcatenationPlugin` in the 
production guide (as we include this plugin under `-p`, it also makes sense to 
mention it in this guide.

* docs(guides): fix issues with examples in shimming.md (#1680)

Rename plugin identifier and require webpack when it is used in the
configuration examples.

* docs(guides): add middleware tip to the hmr guide

Resolves #1682

* Revert "A new --concatenate-modules flag" (#1692)

* update master

* update /content/loaders & /content/plugins

* docs(concepts): fix grammar in output.md (#1694)

* docs(contribute): update writing-a-loader (#1691)

Use normal function instead of arrow function to fix scope in loader
example.

* docs(plugins): add external example in SourceMapDevToolPlugin (#1676)

Demonstrate how one might use the plugin to host source maps externally.

* docs(config): update dev-server open option (#1693)

State the ability to open in specific browser.

* fix bugs

* update /content/loaders & /content/plugins

* docs(api): improve formatting and grammar in loaders.md

* docs(api): clarify fourth parameter of `this.callback` in loaders.md

Add some lead in descriptions to the `Examples` section and clarify that meta
data can be passed along via the fourth parameter to `this.callback` and accepted
as the third parameter to a loader function.

Resolves #1607

* docs(api): populate missing link in loaders.md

* docs(plugins): correct example in html-webpack-plugin (#1698)

* docs(guides): update an example in production.md (#1696)

Switch to shortened form when using the `DefinePlugin` to define the 
`process.env.NODE_ENV` value. This avoids a bug which is mentioned
in the plugin's documentation:

https://webpack.js.org/plugins/define-plugin/#feature-flags

* fix(markdown): fix overflowing inline code (#1701)

Change the css to fix the text inside code tag which was overflowing 
the parent div.

* docs(concepts): update concepts wording (#1702)

Add "static" to "module bundler". Some feedback here was given to me 
on twitter to make sure we are clear with what these terms mean.

* update /content/loaders & /content/plugins

* docs(config): fix dead link to webpack-dev-server example (#1704)

* docs(concepts): use fragment links in usage instructions (#1705)

This is just a quality of life adjustment that updates the list of ways to 
use loaders with fragment links to the relevant section in the docs.  In 
their current state, the section feels like a dead end, abruptly cutting off 
with three bullet points and no examples. While one can read on and 
figure it out, there is a break in focus that is quite distracting.

* docs(guides): add windows usage tip in getting-started (#1671)

* doc(guides): fix grammatical error in build-performance (#1709)

Change "less" to "fewer".

* docs(guides): correct two small typos

* docs(api): remove inadvertent double verb (#1714)

* docs(contribute): fix grammar in writing-a-plugin (#1715)

* docs(config): add semicolon for consistency (#1716)

The final code block was missing a semicolon from the end of the 
first line; added it in to match the other require statements.

* docs(contributing): add note about debian OS (#1721)

Related issue: #1718

* docs(guides): add output example to shimming doc (#1720)

* docs(plugins): use `.includes` over `.indexOf` (#1719)

Really minor but I think `.includes` is more readable to the unfamiliar 
with javascript.

* docs(guides): use `npx` in getting-started (#1708)

Keep the mention the webpack binary's path but use the `npx` utility
now that it ships with Node. Fix some punctuation and grammar. Clarify 
why npm scripts are still useful even over `npx`.

* update /src/content/loaders & /src/content/plugins

* docs(contribute): link compiler docs in writing-a-plugin (#1700)

While authoring plugins the list of hooks is essential knowledge, so a 
link to hooks documentation page should be accessible in the top of 
writing a plugin guide.

* docs(guides): fix `source-map` discrepancy in production.md (#1711)

The `webpack.prod.js` code example in the "Specify the Evironment"
section shows `cheap-module-source-map` for the `devtool` field which is
not recommended for production. This section should show `source-map`
to be consistent with the webpack.prod.js in the previous
"Source Mapping" section.

* docs(guides): rename 'runtime' to 'manifest' in caching.md (#1713)

Preserve CommonsChunkPlugin boilerplate naming consistency as
referenced in the CommonsChunkPlugin documentation (see below)
when extracting webpack runtime and manifest boilerplate.

https://webpack.js.org/plugins/commons-chunk-plugin#manifest-file

* docs(guides): update output to webpack 3.9.1 (#1724)

* docs(plugins): update the source-map-devtool-plugin (#1707)

Clean up formatting a bit and add undocumented options from 
webpack/webpack#5986. Update the external source maps example
to demonstrate path stripping.

* docs(contribute): correct an example in the writers-guide (#1727)

In a section which states the properties must be sorted alphabetically, sort 
the examples alphabetically.

* docs(config): improve formatting and add note about library entry points in output.md

* docs(guides): mention complex entry point configuration in author-libraries

Note that `entry` arrays are not recommended, provide a way to properly expose
stylesheets, and add a link to an `entry` object example.

* docs(config): improve formatting and clarify the string usage in externals

Resolves #1726

* docs(config): fix minor proselint error in externals

* docs(api): clarify the `pitch` method and how it can be used in loaders.md

Resolves #449
Resolves webpack#116

Refactored and enhanced the existing section using much of @sokra's
explanation from:

webpack/webpack#360

* docs(contribute): fix `import` statement in writing-a-loader.md (#1732)

`validateOptions` is exported as a default module.

* docs(config): update devtool production recommendations

* docs(api): remove obsolete cli flag (#1733)

The `--save` option has been removed from webpack's CLI. See the
following pull request for reference:

webpack/webpack#3896

* docs(concepts): add warning about incompatible `import` statements

Resolves #1736

*  docs(config): fix typescript setup in configuration-languages (#1734)

Resolves #1735

* docs: use full `npm install` over `npm i` (#1740)

Most of the guides use the full command, so it's best to stay
consistent.

* docs(guides): fix diff display for webpack.config.js entry object

Resolves #1743

* docs: fix typos

* docs: add tbroadley to contributor lists

* docs(contribute): correct schema example in `writing-a-loader.md` (#1753)

* docs(guides): add pwa guide (#1737)

Add `progressive-web-application.md` guide which documents how
to use the `workbox-webpack-plugin` to build an offline app. More
on PWAs in webpack can be added here by future contributors.

Resolves #1145

* docs(guides): highlight css splitting in production

Resolves #1741

* docs(plugins): use `.includes` over `.indexOf`

Consistent usage of `.includes`

* docs(config): omit invalid `detailed` option in stats.md (#1757)

* fix(mobile): correctly sort pages in mobile sidebar (#1759)

* chore(vote): port voting app, update deps, and simplify config (#1717)

Port the voting app to a it's own repository and expose that section
of the site more prominently (in the header). This commit also...

- Simplifies the webpack config slightly and allows external styles.
- Updates issue template to highlight content from other repositories.
- Updates some outdated dependencies.

* docs(readme): reformat at 80 characters and include browserstack link

By including this, _BrowserStack_ will allow us to do free testing of
the site on their platform.

* refactor(notification): simplify notification message and bump the version

* fix(splash): fix visualization artifacts (#1762)

Rebuild and clean up visualization in Sketch. Include via an
inline SVG rather than an `<img>` tag. Add a `TODO` in regards
to an even cleaner setup post build refactoring.

Resolves #1752

* chore: pick up vote fix and update yarn lock file

* chore(vote): pick up another vote patch

* Update index.md (#423)

* update: git merge -> git rebase

* Update index.md

* Update README.md

* Update .travis.yml

* docs: fix formatting and grammar (#1765)

Fix typos, improve grammar, and change `&nbsp;` to a normal
space character.

* docs(concepts): change loader order from chonological to reverse (#1767)

When one starts to learn about loaders it's very confusing.
[This](https://webpack.js.org/contribute/writing-a-loader/#complex-usage)
explains the behaviour much better.

* update UPDATE.md
  • Loading branch information
dear-lizhihua authored Jan 13, 2018
1 parent 9201103 commit ec5aac4
Show file tree
Hide file tree
Showing 61 changed files with 1,495 additions and 1,666 deletions.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
- [ ] Check the current issues to ensure you aren't creating a duplicate.
- [ ] Consider making small typo fixes and such directly as pull requests.
- [ ] For the voting application, go to https://github.com/webpack-contrib/voting-app.
- [ ] For loader/plugin docs, consider opening an issue in the corresponding repository.
- [ ] No existing issue? Go ahead and open a new one.
- __Remove these instructions from your PR as they are for your eyes only.__
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,48 +44,62 @@ npm start

# webpack.js.org

[![build status](https://secure.travis-ci.org/webpack/webpack.js.org.svg)](http://travis-ci.org/webpack/webpack.js.org)
[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
[![Build Status][13]][10]
[![Standard Version][12]][11]

Guides, documentation, and all things webpack.


## Content Progress

Now that we've covered much of the backlog of _missing documentation_, we are starting
to heavily review each section of the site's content to sort and structure it appropriately.
The following issues should provide a pretty good idea of where things are, and where
they are going:
Now that we've covered much of the backlog of _missing documentation_, we are
starting to heavily review each section of the site's content to sort and
structure it appropriately. The following issues should provide a pretty good
idea of where things are, and where they are going:

- [Guides - Review and Simplify][1]
- [Concepts - Review, Organize, Define Clear Goals][2]
- [Concepts - Review and Organize][2]
- [API - v4 Rewrite][8]

We haven't created issues for the other sections yet, but they will be coming soon. For
dev-related work please see [General - Current Longterm Plan][3], which will soon be
replaced by a more dev-specific issue.
We haven't created issues for the other sections yet, but they will be coming
soon. For dev-related work please see [General - Updates & Fixes][3].


## Translation

If you hope to localize this documentation please jump to the [translate branch][4].
To help translate this documentation please jump to the [translate branch][4].


## Contributing

Read through the [writer's guide][7] if you're interested in editing the content on this
site. See the [contributors page][5] to learn how to set up and start working on the site
locally.
Read through the [writer's guide][7] if you're interested in editing the
content on this site. See the [contributors page][5] to learn how to set up and
start working on the site locally.


## License

The content is available under the [Creative Commons BY 4.0][6] license.


## Special Thanks

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

[![BrowserStackLogo](./browserstack-logo.png)][9]


[1]: https://github.com/webpack/webpack.js.org/issues/1258
[2]: https://github.com/webpack/webpack.js.org/issues/1386
[3]: https://github.com/webpack/webpack.js.org/issues/1380
[3]: https://github.com/webpack/webpack.js.org/issues/1525
[4]: https://github.com/webpack/webpack.js.org/tree/translation
[5]: https://github.com/webpack/webpack.js.org/blob/master/.github/CONTRIBUTING.md
[6]: https://creativecommons.org/licenses/by/4.0/
[7]: https://webpack.js.org/writers-guide
[8]: https://github.com/webpack/webpack.js.org/pull/1754
[9]: http://browserstack.com/
[10]: http://travis-ci.org/webpack/webpack.js.org
[11]: https://github.com/conventional-changelog/standard-version
[12]: https://img.shields.io/badge/release-standard%20version-brightgreen.svg
[13]: https://secure.travis-ci.org/webpack/webpack.js.org.svg
5 changes: 5 additions & 0 deletions UPDATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## 更新记录

### 2018.01.13
* 合并记录:合并 master 分支
* 合并记录:https://github.com/webpack-china/webpack.js.org/pull/433
Binary file added browserstack-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 12 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,20 +47,20 @@
"antwar-helpers": "^0.19.0",
"antwar-interactive": "^0.19.0",
"async": "^2.5.0",
"autoprefixer": "^7.1.3",
"autoprefixer": "^7.2.3",
"babel-core": "^6.26.0",
"babel-eslint": "^7.2.3",
"babel-loader": "^7.1.2",
"babel-plugin-transform-class-properties": "^6.24.1",
"babel-plugin-transform-object-rest-spread": "^6.26.0",
"babel-preset-env": "^1.6.0",
"babel-preset-react": "^6.24.1",
"copy-webpack-plugin": "^4.0.1",
"copy-webpack-plugin": "^4.3.0",
"css-loader": "^0.28.5",
"duplexer": "^0.1.1",
"eslint": "4.5.0",
"eslint-loader": "^1.9.0",
"eslint-plugin-markdown": "^1.0.0-beta.6",
"eslint-plugin-markdown": "^1.0.0-beta.7",
"extract-text-webpack-plugin": "^3.0.0",
"file-loader": "^0.11.2",
"fontgen-loader": "^0.2.1",
Expand All @@ -69,22 +69,22 @@
"github": "^10.0.0",
"html-webpack-plugin": "^2.30.1",
"http-server": "^0.10.0",
"hyperlink": "^3.0.0",
"hyperlink": "^3.0.1",
"loader-utils": "^1.1.0",
"lodash": "^4.17.4",
"markdown-loader": "^2.0.1",
"markdownlint": "^0.6.0",
"markdownlint-cli": "^0.3.1",
"marked": "^0.3.6",
"marked": "^0.3.7",
"mkdirp": "^0.5.1",
"modularscale-sass": "^3.0.3",
"moment": "^2.18.1",
"moment": "^2.20.1",
"ncp": "^2.0.0",
"node-sass": "^4.5.3",
"npm-run-all": "^4.1.1",
"postcss-loader": "^2.0.6",
"prism-languages": "^0.3.3",
"prismjs": "^1.6.0",
"prismjs": "^1.9.0",
"raw-loader": "^0.5.1",
"request": "^2.81.0",
"sass-loader": "^6.0.6",
Expand All @@ -94,21 +94,22 @@
"tap-parser": "^6.0.1",
"through2": "^2.0.3",
"url-loader": "^0.5.9",
"webpack": "^3.5.5",
"webpack-dev-server": "^2.7.1",
"webpack": "^3.10.0",
"webpack-dev-server": "^2.9.7",
"webpack-merge": "^4.1.0",
"yaml-frontmatter-loader": "^0.1.0"
},
"dependencies": {
"ajv": "^5.2.2",
"preact": "^8.2.5",
"ajv": "^5.5.2",
"preact": "^8.2.7",
"preact-compat": "3.17.0",
"prop-types": "^15.5.10",
"react": "^15.6.1",
"react-dom": "^15.6.1",
"react-router": "^4.2.0",
"react-router-dom": "^4.2.2",
"tool-list": "^0.11.0",
"webpack.vote": "^0.1.2",
"whatwg-fetch": "^2.0.3"
}
}
1 change: 0 additions & 1 deletion src/assets/homepage-modules.svg

This file was deleted.

4 changes: 4 additions & 0 deletions src/components/Navigation/Links.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
"title": "参与贡献",
"url": "contribute"
},
{
"title": "投票",
"url": "vote"
},
{
"title": "博客",
"url": "//medium.com/webpack"
Expand Down
21 changes: 10 additions & 11 deletions src/components/NotificationBar/NotificationBar.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import React from 'react';
import Container from '../Container/Container';
import testLocalStorage from '../../utilities/test-local-storage';

const version = '1';
const version = '2';
const localStorageIsEnabled = testLocalStorage() !== false;

export default class NotificationBar extends React.Component {
Expand All @@ -13,17 +13,16 @@ export default class NotificationBar extends React.Component {
<div className={ `notification-bar ${dismissedMod}` }>
<Container className="notification-bar__inner">
<p>
赞助 webpack,同时获取官方衣服!访问 <a href="https://webpack.threadless.com">webpack 官方商店!</a>&nbsp; 查看所有收益请转到 webpack 的 <a href="https://opencollective.com/webpack">Open Collective 页面!</a>
</p>
<p>
<a href="http://www.unixstickers.com/tag/webpack">Unixstickers!</a> 上购买全新的 webpack 贴纸
{localStorageIsEnabled ?
<button
className="notification-bar__close icon-cross"
onClick={ this._close.bind(this) } /> :
null
}
赞助 webpack,同时从<a href="https://webpack.threadless.com">官方商店</a>购买衣服{' '}
或者在<a href="http://www.unixstickers.com/tag/webpack">这里</a>购买贴纸!所有收益将转到我们的{' '}
<a href="https://opencollective.com/webpack">open collective</a>
</p>
{ localStorageIsEnabled ?
<button
className="notification-bar__close icon-cross"
onClick={ this._close.bind(this) } /> :
null
}
</Container>
</div>
);
Expand Down
14 changes: 5 additions & 9 deletions src/components/NotificationBar/NotificationBar.scss
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@
color: getColor(white);
background: getColor(emperor);

p:not(:last-child) {
padding-bottom: 1em;
}

p {
font-size: 14px;
}
Expand Down Expand Up @@ -36,15 +32,15 @@
}

.notification-bar__close {
color: getColor(white);
font-size: 16px;
padding: 0;
background: none;
border: none;
position: absolute;
font-size: 16px;
top: 10px;
right: 1em;
padding: 0;
border: none;
cursor: pointer;
color: getColor(white);
background: none;
transition: color 250ms;

&:hover {
Expand Down
10 changes: 9 additions & 1 deletion src/components/Site/Site.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,17 @@ const Site = ({
title: section.path.title,
url: section.url,
pages: section.pages.map(page => ({
file: page.file,
title: page.file.title,
url: page.url
}))
})).sort(({ file: { attributes: a }}, { file: { attributes: b }}) => {
let group1 = a.group.toLowerCase();
let group2 = b.group.toLowerCase();

if (group1 < group2) return -1;
if (group1 > group2) return 1;
return a.sort - b.sort;
})
}))
} />

Expand Down
6 changes: 2 additions & 4 deletions src/components/SplashViz/SplashViz.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import React from 'react';

import Cube from '../Cube/Cube';
import TextRotator from '../TextRotater/TextRotater';
import Modules from '../../assets/homepage-modules.svg';
import homeSVG from './SplashVizSVG';

export default class SplashViz extends React.Component {

Expand All @@ -18,9 +18,7 @@ export default class SplashViz extends React.Component {
<span> styles </span>
</TextRotator>
</h1>
<div className="splash-viz__modules">
<img src={ Modules } alt="dependency bundling graphic"/>
</div>
<div className="splash-viz__modules" dangerouslySetInnerHTML={{__html: homeSVG.body}}></div>
<Cube className="splash-viz__cube" depth={ 120 } repeatDelay={ 5000 } continuous/>
</section>
);
Expand Down
7 changes: 4 additions & 3 deletions src/components/SplashViz/SplashViz.scss
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,17 @@
position: absolute;
left: 0;
right: 0;
top: 0;
top: 50%; // vertical center
bottom: 0;
width: 75vw;
min-width: 550px;
max-width: map-get($screens, large);
margin: auto;
margin: 0 auto;
transform: translateY(-50%); // vertical center
display: none;

@include break {
display: block;
display: table; // Get height of its child svg
}

img {
Expand Down
Loading

0 comments on commit ec5aac4

Please sign in to comment.