root
/
webpack
mirror of https://github.com/webpack/webpack.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1 from shama/doc-typos 

docs: typo fixes
This commit is contained in:
Tobias Koppers 2012-05-01 00:34:02 -07:00
parent 1d1f3975d0 54af6f24ed
commit dc64e3f8b1
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -4,11 +4,11 @@ As developer you want to reuse existing code.
As with node.js and web all files are already in the same language, but it is extra work to use your code with the node.js module system and the browser. As with node.js and web all files are already in the same language, but it is extra work to use your code with the node.js module system and the browser.
The goal of `webpack` is to bundle CommonJs modules into javascript files which can be loaded by `<script>`-tags. The goal of `webpack` is to bundle CommonJs modules into javascript files which can be loaded by `<script>`-tags.
Simply concating all required files has a disadvantage: many code to download (and execute) on page load. Simply concatenating all required files has a disadvantage: many code to download (and execute) on page load.
Therefore `webpack` uses the `require.ensure` function ([CommonJs/Modules/Async/A](http://wiki.commonjs.org/wiki/Modules/Async/A)) to split your code automatically into multiple bundles which are loaded on demand. Therefore `webpack` uses the `require.ensure` function ([CommonJs/Modules/Async/A](http://wiki.commonjs.org/wiki/Modules/Async/A)) to split your code automatically into multiple bundles which are loaded on demand.
This happens mostly transparent to the developer. This happens mostly transparent to the developer.
Dependencies are resolved for you. Dependencies are resolved for you.
The result is a smaller inital code download which results in faster page load. The result is a smaller initial code download which results in faster page load.
Another common thing in web development is that some files have to be preprocessed before send to the client (ex. template files). Another common thing in web development is that some files have to be preprocessed before send to the client (ex. template files).
This introduce more complexity to the compile step. This introduce more complexity to the compile step.
@ -27,11 +27,11 @@ You as developer can use such files like any other module.
* make node.js and browser development similar * make node.js and browser development similar
* minimize code size (mobile connection) * minimize code size (mobile connection)
* minimize code size on inital download * minimize code size on initial download
* download code only on demand * download code only on demand
* require minimal configuration, but offer a maximum * require minimal configuration, but offer a maximum
* load polyfills for node-specific things if used * load polyfills for node-specific things if used
* offer replacements for node buildin libaries * offer replacements for node buildin libraries
# Example # Example
@ -150,7 +150,7 @@ function getTemplate(templateName) {
``` ```
In addition to that `webpack` uses the `require.context` function automatically In addition to that `webpack` uses the `require.context` function automatically
if you use variables or other not parseable things in the `require` function. if you use variables or other not parse-able things in the `require` function.
That means the following code behaves like the above: That means the following code behaves like the above:
``` javascript ``` javascript
@ -179,7 +179,7 @@ The following example loads the raw content of a file with the `raw` loader:
var content = require("raw!./file.txt"); var content = require("raw!./file.txt");
``` ```
Multiple loader plugins can be prepended by seperating them with `!`. Multiple loader plugins can be prepended by separating them with `!`.
The loader plugins are resolved like in normal `require` call but with different default extension. The loader plugins are resolved like in normal `require` call but with different default extension.
The `raw` loader plugin is looked up at modules `raw-webpack-web-loader`, `raw-webpack-loader`, `raw-web-loader`, `raw-loader`, `raw` The `raw` loader plugin is looked up at modules `raw-webpack-web-loader`, `raw-webpack-loader`, `raw-web-loader`, `raw-loader`, `raw`
@ -197,7 +197,7 @@ The following loaders are included in webpack:
* `css`: Loads css file with resolved imports and returns css code * `css`: Loads css file with resolved imports and returns css code
* `style`: Adds result of javascript execution to DOM * `style`: Adds result of javascript execution to DOM
* (`.css` defaults to `style!css` loader, so all css rules are added to DOM) * (`.css` defaults to `style!css` loader, so all css rules are added to DOM)
* `script`: Executes a javascript file once in global context (like in script tag), requires are not parsed. Use this to include a libary. ex. `require("script!./jquery.min.js")`. This is synchron, so the `$` variable is avalible after require. * `script`: Executes a javascript file once in global context (like in script tag), requires are not parsed. Use this to include a library. ex. `require("script!./jquery.min.js")`. This is synchron, so the `$` variable is available after require.
TODO TODO

4
examples/README.md
View File

@ -6,11 +6,11 @@ example demonstrating a very simple case of Code Splitting.
## require.context ## require.context
example demonstrating to automatic creation of contextes when using variables in `require`. example demonstrating to automatic creation of contexts when using variables in `require`.
## code-splitted-require.context ## code-splitted-require.context
example demonstrating contextes in a code-splitted environment. example demonstrating contexts in a code-split environment.
## loader ## loader