About

February 7, 2011 at 12:00 AM

Push is a simple program for building static sites such as simple blogs or documentation. Only a simple fileserver such as Apache or NGINX is need to serve your site once it is built.

Status

Push is still in the pre-alpha stages of development, many new features are still in the works. Push can be used now but may require some patience.

How to Use Push

February 7, 2011 at 12:30 AM

Keep in mind push is in it infancy so pretty much everything in these docs are bound to change soon.

To use Push to create a site one simply need two things, a directory full of markdown files and a directory containing templates.

Create a git repo containing the following directories...

• docs - the folder that contains ones markdown files. These will make up the content of ones site.

• templates - the folder that contains ones templates. You will need at least two templates, index.html will be the sites index and article.html which will be used to generate each article

You will also need a file called site.conf in the top level of your repo, for now this file can be blank.

When these files have been put in place all one must do is run push build in the base of the git repo. This will build your sites in the build directory.

Installation

February 7, 2011 at 12:14 AM

Installation current means building Push from source. You will need to clone the Push repo from git hub and you will also need rstemplates which can be cloned from github.
You will need ghc >= 6 and cabal-install to complete the following steps.

• Clone the repos:

    git clone git://github.com/jamessanders/rstemplate.git
    git clone git://github.com/jamessanders/Push.git
  

• Install:

    cd rstemplate && cabal install --constrain="mtl<2"
    cd Push && cabal install
  

• Enjoy