Quick start

Note

For in depth documentation please see user manual.

pip install pagegen

Can also be used in a vitual environment.

$ mkdir pagegen_virtualenv
$ virtualenv pagegen_virtualenv
$ cd pagegen_virtualenv
$ source bin/activate
$ pip install pagegen

Create example site

First initialise a new Pagegen site directory. If using pagegen from a virtual environment, do this from that directory (pagegen_virtualenv in the example above).

$ mkdir my_site
$ cd my_site
$ pagegen --init

The above creates an example pagegen framework of files and folders in the content directory.

Warning

Python does not seem to detect locale on Mac OS X, returning a ValueError, 'unknown locale'. Try running pagegen command as LC_ALL=en_US.UTF-8 pagegen ... To make permanent add export LC_ALL=en_US.UTF-8 to ~/.profile

Generate example site

We are now ready to generate the site. This will create the finished site in the my_site/site/production/ directory.

$ pagegen --generate

The my_site/site/production directory now contains a freshly generated site ready for upload to a web server.

Customize layout

Pagegen adds layout and navigation elements to each page when they are processed. To change the site look and feel change my_site/page.template and add required elements to my_site/include directory, e.g. css, images, javascript etc..