Skip to content

Fix document examples for the correct usage #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rockallite wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix document examples for the correct usage #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ map: {
}
```

If you put the `require-css` directory in a path other than the default `baseUrl` location, you **MUST** add the following [paths configuration](http://requirejs.org/docs/api.html#config-paths) in RequireJS:

```javascript
paths: {
'require-css': 'your/path/to/require-css'
}
```

This configuration is **required** to location `normalize.js` and `css-builder.js` files for optimization.

Use Cases and Benefits
----------------------

Expand Down Expand Up @@ -86,7 +96,7 @@ Optimizer configuration:
modules: [
{
name: 'mymodule',
exclude: ['css/normalize']
exclude: ['require-css/normalize']
}
]
}
Expand All @@ -105,7 +115,7 @@ Then the optimizer output would be:
-mymodule.js containing:
style.css and page.css which will be dynamically injected

The `css/normalize` exclude is needed due to [r.js issue #289](https://github.com/jrburke/r.js/issues/289)
The `require-css/normalize` exclude is needed due to [r.js issue #289](https://github.com/jrburke/r.js/issues/289)

### Separate File Output

Expand Down Expand Up @@ -134,7 +144,7 @@ The RequireJS Optimizer Configuration for this is:

```javascript
{
stubModules: ['require-css'],
stubModules: ['require-css/css'],
}
```

Expand Down