Frasco

Jekyll starter project including full setup for Gulp, Sass, Autoprefixer, Bourbon/Neat/Bitters, Browserify, Imagemin, Browsersync, etc.

Features

• Gulp
• Sass
• Autoprefixer
• Bourbon/Neat/Bitters
• Browserify
• Watchify
• UglifyJS
• Imagemin
• Browsersync

Bourbon is a lightweight Sass framework. If you don't use it, it will do nothing to your CSS file.

System Preparation

To use this starter project, you'll need the following things installed on your machine.

1. Jekyll - $ gem install jekyll
2. NodeJS - use the installer, Homebrew, etc.

Local Installation

1. Clone this repo, or download it into a directory of your choice.
2. Inside the directory, run npm install.

Usage

Development Mode

This will give you file watching, browser synchronisation, auto-rebuild, CSS injecting, etc.

$ npm start

Or, if you have installed Gulp globally, this is also available and is same as npm start.

$ gulp

Build for Production

This will set the JEKYLL_ENV to production and use the production config file(s) set in gulpconfig.json to override default settings.

$ npm run build-production

To See More Commands

This will display all available commands.

$ npm run

Jekyll

As this is just a Jekyll project, you can use any of the commands listed in their docs

Configurations and Defaults

You can change the configurations by editing frascoconfig.json

port

default: 4000
options: integer

tasks

Tasks to run when you exec npm start or gulp commands.

browserify

To use Browserify.

default: true
options: boolean (true / false)

imagemin

To minify images.

default: true
options: boolean (true / false)

sass

To compile Sass.

default: true
options: boolean (true / false)

server

To compile sources via Jekyll and to keep browsers in sync with file changes via Browsersync.

default: true
options: boolean (true / false)

watch

To watch files and run tasks on file changes.

paths

Settings about paths.

dest

The destination directory for the whole project.

default: "_site"
options: string

posts

The directory of posts source files.

default: "_posts"
options: string

assets

The directory to gather all assets.

default: "./assets"
options: string
example: "./" (directly under the theme direcotry)

css

The CSS destination directory for Sass.

default: "css"
options: string
example: "stylesheets"

js

The JavaScript destination directory for Browserify.

default: "js"
options: string
example: "javascripts"

images

The destination directory of compressed image files for Imagemin.

default: "images"
options: string
example: "img"

sass

The directory of Sass files.

default: "_sass"
options: string
example: "src/sass"

jsSrc

The directory of JavaScript source files to bundle up by Browserify.

default: "_js"
options: string
example: "src/js"

imagesSrc

The directory of image source files to compress.

default: "_images"
options: string
example: "src/images"

jekyll

Jekyll settings.

config

Jekyll config files.

default

The default Jekyll config file(s).

default: "_config.yml options: string ("FILE1[,FILE2,...]") example: "_config1.yml,_config2.yml

development

Development mode config file(s) to override default settings.

default: "" options: string ("FILE1[,FILE2,...]") example: "_config_development"

production

Production mode config file(s) to override default settings.

default: "" options: string ("FILE1[,FILE2,...]") example: "_config_production"

sass

Sass settings.

outputStyle

The output style of Sass.

default: "compressed"
options: "expanded", "nested", "compact", "compressed"

autoprefixer

Autoprefixer settings.

browsers

List of browsers, which are supported in your theme.

default: ["> 1%", "last 2 versions", "Firefox ESR"]
options: array. See Browserslist docs for available queries. example: ["> 5%", "last 2 versions", "IE 8"]

js

JavaScript settings.

src

File name(s) of JavaScript source file(s).

default: ["main.js"]
options: array
example: ["pluginA.js", "pluginB.js", "main.js"]

dist

The distribution JavaScript file name.

default: "main.js"
options: string
example: "script.js"

Copyright / License

Copyright © 2015-2016 the contributors of the Frasco project under the MIT License.