kalastatic

kalastatic

Static site application framework for prototyping and styleguiding.

Install

Dependencies

• node 4, 5 or 6

Globally

$ npm install kalastatic -g

Project Dependency

To install KalaStatic as a dependency in your project:

$ npm install kalstatic --save

Usage

Convention

Construct your source files, using the template engine name in the file extension.

src/index.html.jade

---
youAreUsingJade: true
pretty: true
---
doctype html
html(lang="en")
  head
    title= title
  body
    h1 Jade - node template engine

Configuration

KalaStatic can be configured through a kalastatic.yaml file. The default options are as follows:

# The base directory of where the base KalaStatic lives.
base: '.',

# The directory (from base), where the source content files live.
source: 'src',

# Where to build out the files.
destination: 'build',

# The options to pass off to the Metalsmith plugins when building, keyed by plugin name.
pluginOpts: {}

# KSS Styleguide Configuration
kss:
  # Set the path to a custom KSS Builder
  builder: null
  title: "Styleguide"
  homepage: styles/homepage.md
  css: ../styles/main.css
  source:
    - src/components/
    - src/styles/

Build

Globally

$ kalastatic build

Project Dependency

$ node_modules/.bin/kalastatic build

API

KalaStatic can be used a JavaScript API. Calling KalaStatic() will build, and return a Promise.

var KalaStatic = require('kalastatic')
KalaStatic('path/to/site').then(function() {
  // Site built
})

Changelog

2.2.4: 2016-12-19

• Update Twig