Static2000 NPM

Static2000

The simple static site generator built on node.js

Installation

Via npm:

npm install static2000

You also need a template adapter, such as static2000-jade:

npm install static2000-jade --save-dev

Usage

Static2000 takes templates and content and mashes them together to create a folder structure and html files. It can be used from the command line or inside a node module and plays nice with Gulp. Gulp is the recommended method of running Static2000, since it does not have any CSS preprocessing or similar built in.

Templates and content can use jade or nunjucks with YAML front matter for defining properties on content pages using template adapters.

Static2000 now has a Yeoman generator which simplifies setup considerably. Read about it here: generator-static2000 and install it with

npm install -g generator-static2000

See the documentation for more information.

Options

templates Source folder for templates. Default is templates.
content Source folder for content. Default is content.
baseUrl Base URL for the site. Set this to create an XML sitemap when generating the site.
templateAdapter The template adapter to use. Default is static2000-jade.
dest Destination folder for generated html. Optional. If specified, generated files will be written to that location. If not, you can write them to disk using vinyl-fs.
globalFunctions An object with functions that should be available on all pages and in all templates. Optional. Note that it is often better to use a jade mixin defined in templates/includes/globals.jade or a global plugin instead.

API

Static2000 exports one function that takes three optional arguments: options (see above), a success callback and and error callback. The function returns a stream of generated html files and a sitemap xml if baseUrl was specified.

var static2000 = require('static2000');

static2000(options, onSuccess, onError);

Gulp

Using static2000 together with Gulp is simple, no plugin required. Since 0.3.0, static2000 returns a stream that can be piped to gulp.dest() to write the files to disk and optionally process them.

var static2000 = require('static2000');

gulp.task('static2000', function() {
    return static2000()
        .pipe(gulp.dest('www'));
});

Change Log

0.4.2

Parallellized sitemap and page generation.
Updated mocha and minimatch dependencies.
Removed gulp.

0.4.1

Updated vinyl-fs dependency.

0.4.0

Model plugins.

0.3.0

Now returns a stream of generated files. Makes it easy to post-process the files with plugins when using gulp.

0.2.1

Added loading of global plugins. It's now possible to write plugins that extend the globals object in templates and have access to options and a list of all content models.

0.2.0

Extracted template engines into adapters. This is a breaking change. Static2000 now requires a template adapter to work, and none is included. Install with npm i static2000-jade for jade templates.