|
2 | 2 |
|
3 | 3 | Connect/Express middleware for [node-sass](https://github.com/sass/node-sass). |
4 | 4 |
|
5 | | -[](https://travis-ci.org/sass/node-sass-middleware) |
| 5 | +[](https://github.com/sass/node-sass-middleware/actions/workflows/ci.yml) |
6 | 6 | [](http://badge.fury.io/js/node-sass-middleware) |
7 | | -[](https://david-dm.org/sass/node-sass-middleware) |
8 | | -[](https://david-dm.org/sass/node-sass-middleware#info=devDependencies) |
9 | 7 | [](https://gitter.im/sass/node-sass) |
10 | 8 |
|
11 | 9 | ## Install |
12 | 10 |
|
13 | | - npm install node-sass-middleware |
| 11 | +```bash |
| 12 | +npm install node-sass-middleware |
| 13 | +``` |
14 | 14 |
|
15 | 15 | ## Usage |
16 | 16 |
|
@@ -93,22 +93,21 @@ http.createServer(app).listen(3000); |
93 | 93 |
|
94 | 94 | ### Options |
95 | 95 |
|
96 | | - * `src` - (String) Source directory used to find `.scss` or `.sass` files. |
97 | | - |
98 | | -#### Optional configurations: |
| 96 | +* `src` - (String) Source directory used to find `.scss` or `.sass` files. |
99 | 97 |
|
100 | | - * `beepOnError` - Enable beep on error, false by default. |
101 | | - * `debug` - `[true | false]`, false by default. Output debugging information. |
102 | | - * `dest` - (String) Destination directory used to output `.css` files (when undefined defaults to `src`). |
103 | | - * `error` - A function to be called when something goes wrong. |
104 | | - * `force` - `[true | false]`, false by default. Always re-compile. |
105 | | - * `indentedSyntax` - `[true | false]`, false by default. If true compiles files with the `.sass` extension instead of `.scss` in the `src` directory. |
106 | | - * `log` - `function(severity, key, val, message)`, used to log data instead of the default `console.error`. "severity" matches [Winston](https://www.npmjs.com/package/winston) severity levels. |
107 | | - * `maxAge` - MaxAge to be passed in Cache-Control header. |
108 | | - * `prefix` - (String) It will tell the sass middleware that any request file will always be prefixed with `<prefix>` and this prefix should be ignored. |
109 | | - * `response` - `[true | false]`, true by default. To write output directly to response instead of to a file. |
110 | | - * `root` - (String) A base path for both source and destination directories. |
| 98 | +#### Optional configurations |
111 | 99 |
|
| 100 | +* `beepOnError` - Enable beep on error, false by default. |
| 101 | +* `debug` - `[true | false]`, false by default. Output debugging information. |
| 102 | +* `dest` - (String) Destination directory used to output `.css` files (when undefined defaults to `src`). |
| 103 | +* `error` - A function to be called when something goes wrong. |
| 104 | +* `force` - `[true | false]`, false by default. Always re-compile. |
| 105 | +* `indentedSyntax` - `[true | false]`, false by default. If true compiles files with the `.sass` extension instead of `.scss` in the `src` directory. |
| 106 | +* `log` - `function(severity, key, val, message)`, used to log data instead of the default `console.error`. "severity" matches [Winston](https://www.npmjs.com/package/winston) severity levels. |
| 107 | +* `maxAge` - MaxAge to be passed in Cache-Control header. |
| 108 | +* `prefix` - (String) It will tell the sass middleware that any request file will always be prefixed with `<prefix>` and this prefix should be ignored. |
| 109 | +* `response` - `[true | false]`, true by default. To write output directly to response instead of to a file. |
| 110 | +* `root` - (String) A base path for both source and destination directories. |
112 | 111 |
|
113 | 112 | For full list of options from original node-sass project go [here](https://github.com/sass/node-sass). |
114 | 113 |
|
@@ -149,11 +148,11 @@ npm test |
149 | 148 |
|
150 | 149 | ### Note on Patches/Pull Requests |
151 | 150 |
|
152 | | - * Fork the project. |
153 | | - * Make your feature addition or bug fix. |
154 | | - * Add documentation if necessary. |
155 | | - * Add tests for it. This is important so I don't break it in a future version unintentionally. |
156 | | - * Send a pull request. Bonus points for topic branches. |
| 151 | +* Fork the project. |
| 152 | +* Make your feature addition or bug fix. |
| 153 | +* Add documentation if necessary. |
| 154 | +* Add tests for it. This is important so I don't break it in a future version unintentionally. |
| 155 | +* Send a pull request. Bonus points for topic branches. |
157 | 156 |
|
158 | 157 | ## Copyright |
159 | 158 |
|
|
0 commit comments