Fork me on GitHub

Frasco

Quick starter for Jekyll including full setup for Sass, PostCSS, Autoprefixer, stylelint, Webpack, ESLint, imagemin, Browsersync, etc.

Quick-start Instructions

$ git clone https://github.com/ixkaito/frasco.git
$ cd frasco
$ npm install
$ npm run dev

System Preparation

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

  1. Ruby
  2. Node.js

Local Installation

  1. Clone the repo, or download it into a directory of your choice.

    $ git clone https://github.com/ixkaito/frasco.git
    

    Create a new repository from frasco or Download ZIP

  2. Inside the directory, run npm install or yarn.

    $ cd /path/to/frasco
    $ npm install # or yarn
    

Usage

Start to Develop

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

$ npm run dev # or yarn dev

Build for Production

This will set the JEKYLL_ENV to production to generate files.

$ npm run build # or yarn build

What’s in Frasco

Configurations and Defaults

You can modify the configurations by editing config in package.json.

Default

"config": {
  "browsersync": {
    "port": 4000
  },
  "image": {
    "src": "assets/_src/images",
    "dist": "assets/images"
  },
  "js": {
    "entry": "bundle.js",
    "src": "assets/_src/js",
    "dist": "assets/js"
  },
  "css": {
    "src": "assets/_src/sass",
    "dist": "assets/css",
    "style": "compressed",
    "map": "--map"
  },
  "jekyll": {
    "config": {
      "default": "_config.yml",
      "development": "_config.dev.yml"
    }
  }
}