Jekyllplate

Not just another boilerplate for static Jekyll sites using gulp automations.

This boilerplate includes common useful gulp tasks, auto-reload with BrowserSync and ES6 modules from webpack.

Pre-requisites

• Node.js
• Bower
• Gulp
• Ruby

Installation

Make sure you double-checked the pre-requisites listed above and open your command line interface and enter the following

$ git clone https://github.com/stphn/jekyllplate.git
$ cd jekillplate
$ npm run build
$ gulp serve

et voilà

How to write posts

To add new drafts, add a file in the posts/_drafts directory that follows the naming convention YYYY-MM-DD-name-of-post.ext and includes the necessary YAML front matter:

---
layout: post
title:  Example draft
date:   2017-01-01 00:00:00 +0000
categories: example
tags: example-tag
---

Once you're ready to publish this draft, move the file to posts/_posts.

How to create pages

Create new pages in the root directory (or pretty much any subdirectory). The filename will form part of the URL.

Pages will need front matter as well, for example:

---
layout: default
title: Example Page
permalink: /examples/
nav: true
---

Only pages with nav set to true will appear in the top navigation. Easy.

How to deploy

This is automatically ready to deploy, so long as the gulp server has been running during development.

Built code lives in the _site directory. Deploy this to the prod branch with gulp deploy.

Thanks and credits

• Tobias Reich for his inspiring work
• Van Le for her inspiring work

Still todo

• Include Open Graph protocols
• cleaning up
• and probably a lot more ...