Skip to content

Commit

Permalink
Add plugins configuration documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chasenlehara committed Sep 7, 2017
1 parent cd6cd0b commit 4f35064
Showing 1 changed file with 33 additions and 4 deletions.
37 changes: 33 additions & 4 deletions docs/pages/configuration.md
Expand Up @@ -12,13 +12,16 @@ A basic configuration might look like this:
...
"steal": {
"meta": {
"jquery-plugin": {
"jquery-plugin": {
"deps": ["jquery"]
}
},
"paths": {
},
"paths": {
"some-dep": "lib/some/dep.js"
}
},
"plugins": [
"steal-css"
]
}
}
```
Expand Down Expand Up @@ -71,6 +74,32 @@ import foo from "foo";

Will get the `FOO` global.

## Plugins

Plugins (such as [steal-css](https://www.npmjs.com/package/steal-css)) should be installed as `devDependencies` and added to the `plugins` configuration in your `package.json`.

For example, to use `steal-css`, first install it with npm:

```
npm install steal-css --save-dev
```

Then update the `plugins` configuration in your `package.json`:

```json
{
...
"devDependencies": {
...
"steal-css": "^1.0.0"
},
"steal": {
...
"plugins": ["steal-css"]
}
}
```

## Progressively loaded bundles

In the [steal-tools.guides.progressive_loading progressive loading guide] we show how to progressively load different pages within your app. You import these modules using the [steal.import] function like so:
Expand Down

0 comments on commit 4f35064

Please sign in to comment.