Site Boilerplate

Gulping Handlebars and JSON for GitHub Pages. It's The Most Powerful Static Site Generator Using Gulp. Thanks See Simple boilerplate

Building

Install : nodejs gulp

$ git clone https://github.com/sircus/site-boilerplate.git
$ cd site-boilerplate
$ npm install

build:

$ gulp build

Watch & Connect:

$ gulp

deploy:

$ gulp deploy

Structure

src:

/src
├── / css
├── / js
├── / data
├── / images
├── / partials
└──├── / include

build:

/ gh-pages
├── / css
├── / js
└── / images

Usage

To configure for your project new

• pkg from package.json

example: {{pkg.name}}

"name": "your-project",
"version": "0.0.0",
"author": "yourName <yourEmail@gmail.com> (https://github.com/your-repo)",
"description": "your project description",
"repository": {
  "type": "git",
  "url": "https://github.com/your-repo.git"
},

• site from site.yml

example:  {{site.title}}

title: your site
description: your site description
tags: every1
author: your name
author_url: https://github.com/your-repo
copyright: Copyright (c) 2015 your name. all rights reserved.

• Data from front matter

example: {{file.meta.name}}

Prepared comparison helpers

• is (A equal B)
• isnot (A not equal B)

example: {{#is A "B"}}, {{#isnot A "B"}} and or="C" option

More useful helpers here by Helper team. Some helpers have to check on compatible gulp.

devDependencies

• Handlebars : @wycats (Yehuda Katz)
• gulp-hb: @shannonmoeller (Shannon Moeller)
• handlebars-registrar : @shannonmoeller (Shannon Moeller)
• handlebars-layouts : @shannonmoeller (Shannon Moeller)
• helper-markdown: @{{helpers}} (Jon Schlinkert)
• cssnext: @MoOx (Maxime Thirouin)
• gulp-cssnext: @MoOx (Maxime Thirouin)
• stylestats: @t32k (Koji Ishimoto)
• gulp-stylestats: @1000ch (1000ch)
• sircus: @blivesta (Yasuyuki Enomoto)

Other devDependencies

• Package

License

Released under the MIT license.

Copyright © 2015 @blivesta and @ungki