verse

Verse

Verse is a static site generator, with a couple of twists. First, once any given page of a site loads, your site becomes a single page app. Second, you can easily publish your site to s3.

Installation

npm install -g verse

Usage

To build your site, simply run:

verse build <env>

where <env> is the name of the configuration to use. The configuration is bundled with your site.

To publish to S3, be sure to include the s3 bucket name in your configuration (under s3.bucket). You must have s3cmd installed for this to work.

Site Organization

Your site should be organized as follows:

root
  site.cson
  build
    < created by verse - don't modify >
  env
    < configuration name >
      config.cson
  content
    articles
    posts
    < other content goes here >
  src
    layouts
      < custom layouts (if any) go here >
    gadgets
      < custom gadgets (if any) go here >
    css
      < Nice-based CSS >
  assets
    js
      < javascript goes here >
    img
      < img files go here >
    css
      < css files go here >
    fonts
      < font files go here >

Verse will create an ark, a JavaScript bundle created with ark from build/ark. It will copy your custom gadgets, layouts, content, and environments into the ark and bundle it into a single ark.js file. You want to make sure to include this file in your layouts.

Next, the ark will be copied into your Web directory build/web, along with the additional JavaScript, CSS, etc. Your site.cson file will further determine which pages get generated.

The site.cson File

Your site.cson file consists of a dictionary of objects, each of which describes a page or directory of your site.