fmal / static-boilerplate

Make-based static website builder using Jade and roro

static-boilerplate

This is a very simple boilerplate for writing static sites based on veil by @madx.

It uses Jade for templating, roro for CSS generation and GNU Make for the build system.

Install

# Create your project directory
$ mkdir my-website; cd my-website

# Download the Makefile
$ wget https://raw.github.com/fmal/static-boilerplate/master/Makefile

# Launch the setup task
$ make setup

Usage

Building the site requires exactly one command:

$ make

• Pages are written with Jade and stored in sources/pages/. They will map to a file in your output dir (i.e. sources/pages/index.jade → output/index.html).
• Stylesheets are written with Roro and stored in sources/stylesheets/. They will map to a file in the assets/css/ folder of your output dir (i.e. sources/stylesheets/styles.css → output/assets/css/styles.css).
• Static assets from the static/ folder will be copied in the assets/ folder of your output dir, preserving subdirectories (i.e. static/js/app.js → output/assets/js/app.js).

watch

Provided you have installed either inotify-tools (Linux) or fswatch (OS X), you can use the watch task to continuously rebuild the site as you modify the source files.

$ make watch