@henris/next
Version:
Henri's Sass Toolbelt
190 lines (121 loc) • 8.66 kB
Markdown
# Henri's
## Your Sass Toolbelt
Easily use sass with a toolbelt full of functionality.
This is a beta version of Henri's 1.0. The current stable version of Henri's can be found on [Henri's on Matise](https://github.com/matiseams/henris).
```
npm install @henris/next
```
**More information:**
See [Henri's Documentation](https://henris.style).
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Installing
Installation is simple, just npm install the package and go!
**NPM**
Install the package using npm
```
npm install @henris/next
```
or
```
yarn add @henris/next
```
**Import in project**
Import the file into you main scss file. The base doesn't have any output. So you can @import 'henris'; anywhere without any output.
```
@import '@henris/next';
```
If you want to have the default output from Henri's.
```
@import '~@henris/custom';
$output: set-output(css, true);
// You can add more $output settings here.
@import '~@henris/next';
```
## Running the tests
Tests will check the main functionalities of the package. Install the package locally and run
```
npm run test
```
### And coding style tests
All code is beautyfied using [Prettier](https://www.prettier.io) and [stylelint](https://stylelint.io) with [stylelint-logical-order](https://github.com/silvandiepen/stylelint-logical-order)
## Deployment
Add additional notes about how to deploy this on a live system
## Browser Support
Henri's could use autoprefixer to make (most) Flexbox features compatible with earlier browser versions. According to Can I use, Henri's is compatible with recent versions of:
* Safari
* Chrome
* Firefox
* Opera
* Edge
* Internet Explorer (10+) is only partially supported.
## Built With
* [Node-sass](https://sass-lang.com/) - Sass language compiler
* [Postcss](https://postcss.org/) - Autoprefixer and other functions
* [Ssst](http://github.com/silvandieepn/ssst/) - Sass testing
* [Vuepress](https://vuepress.vuejs.org) - For the docs
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
**Sil van Diepen**
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Modules
### Style
#### Color
[](https://github.com/henris-style/color/issues)
[](https://github.com/henris-style/color/blob/master/LICENSE.MD)
[](https://github.com/henris-style/color)
[](https://www.npmjs.com/package/@henris/color)
#### Grid
[](https://github.com/henris-style/grid/issues)
[](https://github.com/henris-style/grid/blob/master/LICENSE.MD)
[](https://github.com/henris-style/grid)
[](https://www.npmjs.com/package/@henris/grid)
#### Typography
[](https://github.com/henris-style/typography/issues)
[](https://github.com/henris-style/typography/blob/master/LICENSE.MD)
[](https://github.com/henris-style/typography)
[](https://www.npmjs.com/package/@henris/typography)
#### Reset
[](https://github.com/henris-style/reset/issues)
[](https://github.com/henris-style/reset/blob/master/LICENSE.MD)
[](https://github.com/henris-style/reset)
[](https://www.npmjs.com/package/@henris/reset)
#### Ease Gradient
[](https://github.com/henris-style/ease-gradient/issues)
[](https://github.com/henris-style/ease-gradient/blob/master/LICENSE.MD)
[](https://github.com/henris-style/ease-gradient)
[](https://www.npmjs.com/package/@henris/ease-gradient)
### Logic
#### Default
[](https://github.com/henris-style/default/issues)
[](https://github.com/henris-style/default/blob/master/LICENSE.MD)
[](https://github.com/henris-style/default)
[](https://www.npmjs.com/package/@henris/default)
#### Custom
[](https://github.com/henris-style/custom/issues)
[](https://github.com/henris-style/custom/blob/master/LICENSE.MD)
[](https://github.com/henris-style/custom)
[](https://www.npmjs.com/package/@henris/custom)
#### Output
[](https://github.com/henris-style/output/issues)
[](https://github.com/henris-style/output/blob/master/LICENSE.MD)
[](https://github.com/henris-style/output)
[](https://www.npmjs.com/package/@henris/output)
#### Utils
[](https://github.com/henris-style/utils/issues)
[](https://github.com/henris-style/utils/blob/master/LICENSE.MD)
[](https://github.com/henris-style/utils)
[](https://www.npmjs.com/package/@henris/utils)
#### Math
[](https://github.com/henris-style/math/issues)
[](https://github.com/henris-style/math/blob/master/LICENSE.MD)
[](https://github.com/henris-style/math)
[](https://www.npmjs.com/package/@henris/math)
### Script
#### Build
[](https://github.com/henris-style/build/issues)
[](https://github.com/henris-style/build/blob/master/LICENSE.MD)
[](https://github.com/henris-style/build)
[](https://www.npmjs.com/package/@henris/build)