Skip to content


Subversion checkout URL

You can clone with
Download ZIP
The lightweight static content framework.
Ruby CSS
branch: master

This branch is 103 commits ahead of staticmatic:master

Failed to load latest commit information.
bin Don't unnecessarily require lib files when using executable.
lib Add configuration for site and build directories
spec Simplify require paths
website Docs, split up helpers specs, allow preview server to exit on ctrl+c
.gitignore SCSS support if Sass 3 installed
Gemfile Minor update to support compass 0.12.x
Gemfile.lock Minor update to support compass 0.12.x
LICENSE Added jeweler for gem management, removed cruft
Rakefile Uncommented rubygems rake tasks
VERSION.yml Version bump to 2.1.8
staticmatic.gemspec Fix gemspec, stylesheet helper should generate link for scss templates
staticmatic2.gemspec Regenerate gemspec for version 2.1.8

StaticMatic: Build and Deploy

1: Build static websites using modern dynamic tools:

2: Deploy to Amazon S3:

$ staticmatic s3_deploy

3: Profit (due to low hosting fees :P)

In other words:

                StaticMatic build                   StaticMatic deploy
src/                    ==>           build/                ==> 
  index.haml            ==>             index.html          ==>             index.html
  style.sass            ==>             style.css           ==>             style.css
  js/                   ==>             js/                 ==>             js/          ==>               app.js            ==>               app.js
  img/                  ==>             img/                ==>             img/
    logo.png            ==>               logo.png          ==>               logo.png

Getting Started

$ gem install staticmatic2

Quick Start

Setup a new project:

$ staticmatic init my-project

This will give you a basic skeleton:


Preview your static website:

$ cd my-project
$ staticmatic preview
Site root is: .
StaticMatic Preview Server
Ctrl+C to exit

Visit http://localhost:4000 to view your website in action.

To build & convert your haml/sass/whatever files into plain html, css, and javascript:

$ staticmatic build

This will convert everything into a freshly generated build/ folder, 100% static.

If you have an Amazon S3 account and want to deploy to your bucket, run the following command:

# NOTE: You must be in the root folder of your project
$ staticmatic s3_deploy

If you haven't deployed your current project to Amazon yet, it will prompt you to create a config file. Edit this file to include your credentials, run the command again, and you're set.

Super Special Awesome Quick Start Booster

Want to use a Javascript App Starter or a skeleton of your own? Check this out!

$ staticmatic add js-app git://
$ staticmatic init my-new-project --skeleton=js-app

The first line stores a named reference to a repository of your choosing. You only need to do this once.

The second line clones the referenced repository into a freshly created my-new-project folder, as well as removes the .git/ folder so you can do your own git init. Convenient!

Special Folders

  • The _helpers folder is where you place your custom Haml helpers

  • The _layouts folder is where layout files will be searched for. These files must contain a yield statement.

  • The _partials folder is the last place partial files will be searched for. Any partial in this folder should not be prefixed with an underscore _

USEFUL: Any file or folder prefixed with an underscore _ will not be copied into the generated site/ folder, nor will they be converted by haml, coffeescript, etc


Partials are searched for in the following order:

  • The file's current directory (the file must be prefixed with an underscore in this case)
  • src/_partials/


# Searches for the default rendering engine file type (by default, it is haml)
= partial 'sidebar'

# Equivalent to the above statement
= partial 'sidebar.haml'

# Directly inserts html file
= partial 'help-content.html'

# Use your own directory structure
= partial 'blog-content/2011/vacation.markdown'


Force the browser to ignore its cache whenever you damn well feel like it:

# Creates a query string based on the current unix time
stylesheets :menu, :form, :qstring => true

<link href="/css/menu.css?_=1298789103" media="all" rel="stylesheet" type="text/css"/>
<link href="/css/form.css?_=1298789103" media="all" rel="stylesheet" type="text/css"/>

# Or, use your own qstring
javascripts :app, :qstring => '2.0.6'

<script language="javascript" src="js/app.js?_=2.0.6" type="text/javascript"></script>

SSL support

To enable SSL support, add the following lines to configuration/site.rb file:

require 'webrick/https'
configuration.ssl_enable = true
configuration.ssl_private_key_path = "/path/to/key.pem"
configuration.ssl_certificate_path = "/path/to/cert.pem"

Roadmap / TODO list

  • Fix slowness of executable (built on Thor; maybe reconsider?)
  • Create a cache that monitors what files have changed in between Amazon S3 uploads to reduce unnecessary uploads
  • Integrate sprockets both for building and for previewing (probably as an option flag)
  • Change rendering and yielding syntax to rails syntax
  • Create a command that converts a staticmatic project to a rails project


Something went wrong with that request. Please try again.