Skip to content
This repository has been archived by the owner on Oct 12, 2023. It is now read-only.

Commit

Permalink
Update README.md CSS Preprocessor --> node-sass-chokidar alternative …
Browse files Browse the repository at this point in the history
…(#1987)

* resolves facebook/create-react-app#1986 updates CSS Preprocessor docs to include information on node-sass-chokidar alternative to node-sass

* Update README.md
  • Loading branch information
michaelwayman authored and Timer committed Apr 22, 2017
1 parent 5a2a168 commit 429ed08
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions packages/react-scripts/template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,26 @@ Then we can change `start` and `build` scripts to include the CSS preprocessor c

Now running `npm start` and `npm run build` also builds Sass files. Note that `node-sass` seems to have an [issue recognizing newly created files on some systems](https://github.com/sass/node-sass/issues/1891) so you might need to restart the watcher when you create a file until it’s resolved.

**Performance Note**

`node-sass --watch` has been reported to have *performance issues* in certain conditions when used in a virtual machine or with docker. If you are experiencing high CPU usage with node-sass you can alternatively try [node-sass-chokidar](https://www.npmjs.com/package/node-sass-chokidar) which uses a different file-watcher. Usage remains the same, simply replace `node-sass` with `node-sass-chokidar`:

```
npm uninstall node-sass --save-dev
npm install node-sass-chokidar --save-dev
```

And in your scripts:

```diff
"scripts": {
- "build-css": "node-sass src/ -o src/",
- "watch-css": "npm run build-css && node-sass src/ -o src/ --watch --recursive"
+ "build-css": "node-sass-chokidar src/ -o src/",
+ "watch-css": "npm run build-css && node-sass-chokidar src/ -o src/ --watch --recursive"
}
```

## Adding Images, Fonts, and Files

With Webpack, using static assets like images and fonts works similarly to CSS.
Expand Down

0 comments on commit 429ed08

Please sign in to comment.