Skip to content

Commit cb3c0b6

Browse files
joshwiensjoshwiens
authored
Merge pull request webpack-contrib#162 from d3viant0ne/d3viant0ne-UpdateDocsForFinal
chore(readme): Update to webpack standard format
2 parents 5a1a0f8 + 700dd55 commit cb3c0b6

File tree

1 file changed

+55
-6
lines changed

1 file changed

+55
-6
lines changed

‎README.md

+55-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
1-
# style loader for webpack
1+
[![npm][npm]][npm-url]
2+
[![node][node]][node-url]
3+
[![deps][deps]][deps-url]
4+
[![chat][chat]][chat-url]
5+
6+
<div align="center">
7+
<a href="https://github.com/webpack/webpack">
8+
<img width="200" height="200"
9+
src="https://webpack.js.org/assets/icon-square-big.svg">
10+
</a>
11+
<h1>Style Loader</h1>
12+
</div>
213

314
Adds CSS to the DOM by injecting a `<style>` tag
415

5-
## Install
16+
<h2 align="center">Install</h2>
617

718
```
819
npm install style-loader --save-dev
920
```
1021

11-
## Usage
22+
<h2 align="center">Usage</h2>
1223

1324
[Documentation: Using loaders](http://webpack.github.io/docs/using-loaders.html)
1425

@@ -61,7 +72,7 @@ By default, the style-loader appends `<style>` elements to the end of the `<head
6172

6273
If defined, the style-loader will re-use a single `<style>` element, instead of adding/removing individual elements for each required module. **Note:** this option is on by default in IE9, which has strict limitations on the number of style tags allowed on a page. You can enable or disable it with the singleton query parameter (`?singleton` or `?-singleton`).
6374

64-
## Recommended configuration
75+
### Recommended configuration
6576

6677
By convention the reference-counted API should be bound to `.useable.css` and the simple API to `.css` (similar to other file types, i.e. `.useable.less` and `.less`).
6778

@@ -97,6 +108,44 @@ So the recommended configuration for webpack is:
97108

98109
**Note** about source maps support and assets referenced with `url`: when style loader is used with ?sourceMap option, the CSS modules will be generated as `Blob`s, so relative paths don't work (they would be relative to `chrome:blob` or `chrome:devtools`). In order for assets to maintain correct paths setting `output.publicPath` property of webpack configuration must be set, so that absolute paths are generated.
99110

100-
## License
111+
<h2 align="center">Contributing</h2>
101112

102-
MIT (http://www.opensource.org/licenses/mit-license.php)
113+
Don't hesitate to create a pull request. Every contribution is appreciated. In development you can start the tests by calling `npm test`.
114+
115+
<h2 align="center">Maintainers</h2>
116+
117+
<table>
118+
<tbody>
119+
<tr>
120+
<td align="center">
121+
<img width="150 height="150"
122+
src="https://avatars.githubusercontent.com/sokra?v=3">
123+
<br />
124+
<a href="https://github.com/">Tobias Koppers</a>
125+
</td>
126+
<td align="center">
127+
<img width="150 height="150"
128+
src="https://avatars.githubusercontent.com/SpaceK33z?v=3">
129+
<br />
130+
<a href="https://github.com/">Kees Kluskens</a>
131+
</td>
132+
<tr>
133+
<tbody>
134+
</table>
135+
136+
137+
<h2 align="center">LICENSE</h2>
138+
139+
#### [MIT](./LICENSE)
140+
141+
[npm]: https://img.shields.io/npm/v/style-loader.svg
142+
[npm-url]: https://npmjs.com/package/style-loader
143+
144+
[node]: https://img.shields.io/node/v/style-loader.svg
145+
[node-url]: https://nodejs.org
146+
147+
[deps]: https://david-dm.org/webpack/style-loader.svg
148+
[deps-url]: https://david-dm.org/webpack/file-loader
149+
150+
[chat]: https://badges.gitter.im/webpack/webpack.svg
151+
[chat-url]: https://gitter.im/webpack/webpack

0 commit comments

Comments
 (0)