A starter project including full setup for Jekyll, GulpJS, SASS, AutoPrefixer & BrowserSync
Here's a 1.5min screencast showing what you get.
And here's a GIF showing the CSS injecting.
To use this starter project, you'll need the following things installed on your machine.
- Jekyll -
$ gem install jekyll
- NodeJS - use the installer.
- GulpJS -
$ npm install -g gulp
(mac users may need sudo)
- Clone this repo, or download it into a directory of your choice.
- Inside the directory, run
npm install
.
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
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());
});