Skip to content
This repository was archived by the owner on Oct 24, 2025. It is now read-only.

Commit 6c28214

Browse files
committed
chore: fix badges and markdownlint
1 parent 59091f0 commit 6c28214

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
Connect/Express middleware for [node-sass](https://github.com/sass/node-sass).
44

5-
[![Build Status](https://travis-ci.org/sass/node-sass-middleware.svg?branch=master&style=flat)](https://travis-ci.org/sass/node-sass-middleware)
5+
[![Main CI Workflow](https://github.com/sass/node-sass-middleware/actions/workflows/ci.yml/badge.svg)](https://github.com/sass/node-sass-middleware/actions/workflows/ci.yml)
66
[![npm version](https://badge.fury.io/js/node-sass-middleware.svg)](http://badge.fury.io/js/node-sass-middleware)
7-
[![Dependency Status](https://david-dm.org/sass/node-sass-middleware.svg?theme=shields.io)](https://david-dm.org/sass/node-sass-middleware)
8-
[![devDependency Status](https://david-dm.org/sass/node-sass-middleware/dev-status.svg?theme=shields.io)](https://david-dm.org/sass/node-sass-middleware#info=devDependencies)
97
[![Gitter chat](http://img.shields.io/badge/gitter-sass/node--sass-brightgreen.svg)](https://gitter.im/sass/node-sass)
108

119
## Install
1210

13-
npm install node-sass-middleware
11+
```bash
12+
npm install node-sass-middleware
13+
```
1414

1515
## Usage
1616

@@ -93,22 +93,21 @@ http.createServer(app).listen(3000);
9393

9494
### Options
9595

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.
9997

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
11199

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.
112111

113112
For full list of options from original node-sass project go [here](https://github.com/sass/node-sass).
114113

@@ -149,11 +148,11 @@ npm test
149148

150149
### Note on Patches/Pull Requests
151150

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.
157156

158157
## Copyright
159158

0 commit comments

Comments
 (0)