Skip to content

A starter project including full setup for Jekyll, GulpJS, Jade, SASS & BrowserSync

Notifications You must be signed in to change notification settings

kuxn/jekyll-gulp-jade-sass-browser-sync

 
 

Repository files navigation

jekyll-gulp-jade-sass-browser-sync

A starter project including full setup for Jekyll, GulpJS, Jade, SASS, AutoPrefixer & BrowserSync.

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.
  3. GulpJS - $ npm install -g gulp (mac users may need sudo)

Local Installation

  1. Clone this repo, or download it into a directory of your choice.
  2. Inside the directory, run npm install.
  3. Inside the directory assets/css/0-tools, run sudo gem install bourbon, bourbon install.

Usage

development mode

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

$ gulp

jekyll

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

Deploy with Gulp

You can easily deploy your site build to a gh-pages branch. First, follow the instructions at gulp-gh-pages to get your branch prepared for the deployment and to install the module. Then, in gulpfile.js you'll want to include something like the code below. gulp.src() needs to be the path to your final site folder, which by default will be _site. If you change the destination in your _config.yml file, be sure to reflect that in your gulpfile.

var deploy = require("gulp-gh-pages");

gulp.task("deploy", ["jekyll-build"], function () {
    return gulp.src("./_site/**/*")
        .pipe(deploy());
});

About

A starter project including full setup for Jekyll, GulpJS, Jade, SASS & BrowserSync

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 49.8%
  • CSS 34.8%
  • HTML 15.4%