search

stphn / jekyllplate

Starter-kit for static Jekyll sites using gulp automations.
0 stars 0 forks source link

readme

Jekyllplate

Dependencies Build Status Greenkeeper badge

Not just another starter-kit for static Jekyll sites

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

## Pre-requisites

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
$ yarn install
$ yarn start

et voilà

How to write posts

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

---
headline: "First Post Demo"
excerpt: "First Post Excerpt"
categories:
- Web
tags:
- Jekyll
- Starter Kit
---

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: “Blog”
meta_description: “Default Blog Meta Description”
permalink: blog/index.html
current_nav: blog
—

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.

Available Gulp Tasks

`exports.images = images;`
`exports.css = css;`
`exports.js = js;`
`exports.jekyll = jekyll;`
`exports.clean = clean;`
`exports.build = build;`
`exports.watch = watch;`
`exports.default = build;`

Thanks and credits

Still TODO: