scss-to-css/README.md

64 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2018-12-03 14:16:05 +08:00
# scss-to-css
2019-01-05 04:24:17 +08:00
> The easiest way to compile scss file to css without using other tools like `webpack`. And autoprefixer at the same time.
2018-12-03 10:00:21 +08:00
2018-12-17 11:04:13 +08:00
[![Version](https://vsmarketplacebadge.apphb.com/version-short/yutent.scss-to-css.svg)](https://marketplace.visualstudio.com/items?itemName=yutent.scss-to-css)
[![Rating](https://vsmarketplacebadge.apphb.com/rating-short/yutent.scss-to-css.svg)](https://marketplace.visualstudio.com/items?itemName=yutent.scss-to-css)
[![Installs](https://vsmarketplacebadge.apphb.com/installs/yutent.scss-to-css.svg)](https://marketplace.visualstudio.com/items?itemName=yutent.scss-to-css)
[![Build Status](https://travis-ci.org/yutent/scss-to-css.svg?branch=master)](https://travis-ci.org/yutent/scss-to-css)
2019-01-05 04:24:17 +08:00
[README_中文](./README_ZH.md)
Live demo:
2018-12-21 16:41:40 +08:00
![demo](./demo.gif)
2019-01-05 04:24:17 +08:00
## Why Scss-to-css
> For some small project or teaching speech. It's too fat to deploy a webpack env.
> Now, `scss-to-css` help us to compile scss file to css file at a none webpack project and autoprefixer.
2018-12-03 10:00:21 +08:00
2019-01-05 04:24:17 +08:00
## Configuration
> Some configuration can be set, which it works better for you。
>> - `compileOnSave`: Auto compile on document saved, default `true`
>> - `autoPrefixer`: Will autoprefixer. It can be run faster when turn off. default `true`
>> - `output`: Output style. default `compressed`
>> - `exclude`: The RegExp of path what you can to ignore(the `var.scss file` will never be compiled)。
2018-12-03 10:00:21 +08:00
2019-01-05 04:24:17 +08:00
## Issues
> This extension work well on all os. If any problem please let me known [issue](https://github.com/yutent/scss-to-css/issues)
2018-12-03 10:00:21 +08:00
2019-08-05 16:02:59 +08:00
## Dependencies
> We use `node-sass` instead of `libsass`
- `node-sass`, You need to install this module manually. Maybe `root` is required on linux.
2019-01-05 04:24:17 +08:00
## Installation
> Search `scss-to-css` and install in the marketplace.
2018-12-03 10:00:21 +08:00
2019-02-14 13:38:11 +08:00
## .browserslistrc DEMO (Deprecated in 2.x)
2019-01-05 04:24:17 +08:00
> Just for demo, you can change it by youself. If not exists, the default value will be `last 2 version`.
2018-12-03 10:00:21 +08:00
```
2018-12-03 14:16:05 +08:00
ie > 9
iOS > 8
Android >= 4.4
ff > 38
Chrome > 38
```
2019-02-14 13:38:11 +08:00
## .scssrc DEMO (in 2.x or above)
> instead of using `.browserslistrc`, we recommend to use `.scssrc`.
```json
{
"browsers": ["ie > 9", "iOS > 8", "Android >= 4.4", "ff > 38", "Chrome > 38"],
"outdir": "dist" // relative path of this '.scssrc' file.
}
// You can also set other config in this file.
// eg. compileOnSave,autoPrefixer,output,exclude
```