smartsass/README.md

51 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2019-10-14 12:35:26 +00:00
# @pushrocks/smartsass
2017-02-15 23:34:09 +00:00
smart wrapper for sass
2019-10-14 12:35:26 +00:00
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartsass)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsass)
* [github.com (source mirror)](https://github.com/pushrocks/smartsass)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartsass/)
2017-02-15 23:34:09 +00:00
## Status for master
2019-10-14 12:35:26 +00:00
[![build status](https://gitlab.com/pushrocks/smartsass/badges/master/build.svg)](https://gitlab.com/pushrocks/smartsass/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartsass/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartsass/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartsass.svg)](https://www.npmjs.com/package/@pushrocks/smartsass)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartsass/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartsass)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
2017-02-15 23:34:09 +00:00
## Usage
2017-02-15 23:34:09 +00:00
Use TypeScript for best in class instellisense.
2017-03-12 10:28:12 +00:00
```javascript
2017-03-12 11:13:29 +00:00
import * as smartsass from 'smartsass'
2017-03-12 11:09:08 +00:00
import * as bourbon from 'bourbon
import * as neat from 'neat'
let mySmartsass = new smartsass.Smartsass({
filePath: './some.css',
2017-03-12 17:59:57 +00:00
includePaths: bourbon.includePaths
2017-03-12 11:09:08 +00:00
})
mySmartsass.addIncludePaths(neat.includePaths)
let renderedString = mySmartsass.render()
2017-03-12 10:28:12 +00:00
```
2017-02-15 23:34:09 +00:00
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
2017-02-15 23:34:09 +00:00
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
2019-10-14 12:35:26 +00:00
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)