/slipcast

Static website builder that uses Handlebars, Metalsmith, PostCSS (or SCSS), and RollupJS.

Primary LanguageJavaScript

Slipcast: A static website generator

This project simplifies the creation of static websites by using convention over configuration. It relies on Metalsmith, RollupJS, PostCSS, and Handlebars to build a directory of static css, html, and javascript files.

Usage

Add this to your project with npm install slipcast --save. Then you can add the following to your package.json file to build, compress, or run a webserver that watches for changes.

...
    "scripts": {
        "build": "slipcast",
        "compress": "slipcast --compress",
        "eject": "slipcast --eject",
        "start": "slipcast --watch"
    }
...

You can view an example application structure by looking in the tests/fixtures directory of this project. You can ignore the test.json file as it's only used for comparing automated test results.

Config File

The application looks for a file called slipcast.js in the root of the application folder for the configuration.

The configuration file looks like:

module.exports = {
  files: [
    'application.css',
    'application.js'
  ],
  folders: {
    css: 'app/css',
    javascript: 'app/js',
    pages: 'app/pages',
    static: 'app/static',
    views: 'app/views'
  },
  output: 'dist'
};