SLIM {

Ready to go Jekyll framework that automatically compiles your sass to css, deletes unused selectors and minfies the code.

INSTALLATION

GIT CLONING

Slim requires that you have node.js installed on your computer. Now you can setup a new site with slim by cloning the git repository:

git clone git@github.com:chrstnschlnbrg/slim.git yourSite
cd yourSite
rm -rf .git

NODE MODULES

Now you need to install all required node modules gulp, gulp-sass, gulp-uncss, gulp-rename and gulp-cssnano by running the following command:

npm install gulp gulp-sass gulp-uncss gulp-rename gulp-cssnano --save-dev

Your site is ready to use now.

COMPILING

SASS

All your sass files got to /sass. Files with a _ in front of the filename (e.g. _filename.scss) won't be compiled unless you include them in another file.

sass/_hover.scss
sass/_color.scss
sass/_width.scss
...

will be included in:

sass/tachyons.scss

and this file will be compiled to css/full.css. You can change all file names in gulpfile.js. Sass compiling can be done by typing:

rake sass

UNCSS

Uncss will compile css/full.css to css/min.css. You can change the filename in gulpfile.js. Compiling can be done by typing:

rake uncss

JEKYLL

The whole Jekyll site will compiled into site/. This can be done by typing:

rake build

MASTER

The master function will compile your sass, minify it and build your Jekyll site all at once. This can be done by typing:

rake master

DEVELOPING

Jekyll will create a local site at http://127.0.0.1:4000 by typing:

rake local

Now you can also compile your sass everytime you save a file by typing:

rake sasswatch

If your run these two commands in your terminal you will be able to edit all of your files and get them directly compiled on your localhost server. You should also include css/full.css in your head instead of css/min.css while you're developing locally.

SUPPORT/BUGS

If you find something weird just open a new issue on GitHub. You can also contact me via email if you have any problems using Slim.

BUILT WITH TACHYONS / SLIM

MADE BY CHRISTIAN SCHELLENBERG

v1.0

JEKYLL