stasi

STAtic SIte Generator

npm install stasi
1 downloads in the last week
5 downloads in the last month

stasi - work in progress

STAtic SIte Generator

Overview

Stasi is a static site generator.

  • posts are written in any format
  • templates are written in any format
  • all posts/templates has a yaml-front-matter
  • configuration is done in the package.json file
  • plugins decide how to render posts and templates
  • plugins decide how to preview pages
  • plugins decide how to deploy the website

Start a new project

You need the grunt-init template

cd ~/.grunt-init
git clone https://github.com/clauswitt/grunt-init-stasi.git stasi

Then you can create a new website with:

grunt-init stasi

This creates:

  • a package.json with dependencies for your stasi site
  • a stasi.json with your site settings
  • a source directory with dummy data. (a template, a page and a post)
  • a public folder (with a dummy index.html page)
  • a Gruntfile.js to allow using grunt for all tasks
grunt stasi:post "Title of the post"
grunt stasi:page "Title of the page"

To create either a page or a post

grunt stasi:server

to show the pages

grunt stasi:deploy

Plugins

Post / Page

  • Markdown
  • Html

Templating

  • Handlebars

Serving

  • Express

Deploying

  • Rsync

Documentation

Go to http://stasijs.com

Examples

(Coming soon) Go to http://stasijs.com/examples

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Release History

(Nothing yet)

License

Copyright (c) 2013 Claus Witt Licensed under the MIT license.

npm loves you