Skip to content

Commit

Permalink
Readme fixes (#85)
Browse files Browse the repository at this point in the history
* Write 'webpack' in lower-case letters

- "webpack should always be written in lower-case letters.
Even at the beginning of a sentence."
- https://github.com/webpack/media

* Link directly to the Pug documentation

- Requests to jade-lang.com redirect to the pugjs.org frontpage.

* Link to the new documentation website
  • Loading branch information
christianhg authored and TimothyGu committed Mar 19, 2017
1 parent 2659db1 commit e667adf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pug-loader

Pug loader for Webpack.
Pug loader for webpack.

## Usage

Expand All @@ -17,19 +17,19 @@ var html = template(locals);
// => the rendered HTML
```

For more information on how to use Webpack loaders, check the [official documentation][using-loaders].
For more information on how to use webpack loaders, check the [official documentation][using-loaders].

### Legacy `.jade` files

pug-loader fully supports `.jade` files. Just use pug-loader with `.jade` files as you would with a `.pug` file.

### Includes

If you are using [includes], you must make sure that `.pug` (and if needed for legacy files, `.jade`) is bound to pug-loader. Check the Webpack documentation on how to do that for [CLI][module-bind-cli] and for [configuration files][module-bind-config].
If you are using [includes], you must make sure that `.pug` (and if needed for legacy files, `.jade`) is bound to pug-loader. Check the webpack documentation on how to do that for [CLI][module-bind-cli] and for [configuration files][module-bind-config].

### Options

The following options are available to be set as part of the [loader query][query]. They are all mapped directly to Pug options, unless pointed out otherwise.
The following [options] are available to be set for the loader. They are all mapped directly to Pug options, unless pointed out otherwise.

- `doctype`
- Unlike Pug, it defaults to `"html"` if not set
Expand All @@ -39,7 +39,7 @@ The following options are available to be set as part of the [loader query][quer
- Note that you cannot specify any Pug plugins implementing `read` or `resolve` hooks, as those are reserved for the loader
- `pretty`
- `root`
- Webpack uses its own file resolving mechanism, so while it is functionally equivalent to the Pug option with the same name, it is implemented differently
- webpack uses its own file resolving mechanism, so while it is functionally equivalent to the Pug option with the same name, it is implemented differently

### Embedded resources

Expand All @@ -57,9 +57,9 @@ Remember, you need to configure loaders for these file types too. You might be i
[MIT][mit]

[file-loader]: https://github.com/webpack/file-loader
[includes]: http://jade-lang.com/reference/includes/
[includes]: https://pugjs.org/language/includes.html
[mit]: https://www.opensource.org/licenses/mit-license.php
[module-bind-cli]: https://webpack.github.io/docs/using-loaders.html#cli
[module-bind-config]: https://webpack.github.io/docs/using-loaders.html#configuration
[query]: https://webpack.github.io/docs/using-loaders.html#query-parameters
[using-loaders]: https://webpack.github.io/docs/using-loaders.html
[module-bind-cli]: https://webpack.js.org/concepts/loaders/#via-cli
[module-bind-config]: https://webpack.js.org/concepts/loaders/#configuration
[options]: https://webpack.js.org/configuration/module/#useentry
[using-loaders]: https://webpack.js.org/loaders
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "pug-loader",
"version": "2.3.0",
"author": "Tobias Koppers @sokra",
"description": "Pug loader module for Webpack",
"description": "Pug loader module for webpack",
"maintainers": [
"Timothy Gu <[email protected]>"
],
Expand Down

0 comments on commit e667adf

Please sign in to comment.