jacket
v1.1.0
Published
Jacket is a Scss starterkit based on Gulp, Libsass and scss-lint with some sane default tasks and based on the Smacss and BEVM structures.
Downloads
16
Maintainers
Readme
Hi there, Awesome Front-end developer.
A starterkit with a sane default setup, a good starting structure and powerfull front-end tools to back you up.
You can use the Yeoman generator for easy setup.
npm i -g generator-jacket
What front-end tools are included?
- Npm -- Jacket is an npm package. You can find the package here.
- Gulp -- As a build tool, Jacket uses Gulp.
- Sass -- Bourbon & Neat, h5bp normalize, autoprefixer and more.
- Smacss and BEVM -- Structure is Smacss based and BEVM is encouraged.
- Scss linting -- Scss linting lets you lint your scss code.
- BrowserSync -- For crossdevice testing Jacket uses Browsersync.
- Jade -- Jacket is setup with Jade as templating language.
- Sassdoc -- Scss Mixins, functions and more are documented with Sassdoc.
What Gulp tasks can be run?
gulp help
The Help task displays all the gulp tasks.
gulp favicons
The Favicons task can generate your favicons with Realfavicongenerator.
gulp sass
The Sass task compiles your scss to css. This task can do: Globbing, Autoprefixing, Sourcemaps, it includes a jsonImporter and sends a terminal notification when compilation fails.
gulp scss-lint
Based on the .scss-lint.yml the Scss-lint task will check if all the scss code you wrote respects the codig standards.
You should install the gem first with gem install scss_lint
.
gulp jade
The Jade task wil compile all the Jade templates to html files in the dist folder.
gulp browser-sync
The Browser sync task will serve this index.html file at localhost:3000/ and it will watch the scss and jade files and refresh all the devices that are hooked up when these files change.
gulp sassdoc
This tasks can generate all the scss documentation used in Jacket.
gulp watch
This task watches all your files.
Sassdoc?
You can find the doc when you run the gulp sassdoc command.
Jacket • License MIT • © One Agency