Introduction
============

Pelican is a static site generator, written in Python.

This repository contains a Pelican project and theme you can use as a
foundation on which to build your own static HTML website.


Installing Pelican
==================

The easiest way to install Pelican is within a python virtual
environment.  You can create a virtual environment à la carte with
virtualenv, or manage several virtual environments under a single
directory with virtualenvwrapper::

    virtualenv pelican
    cd pelican
    . ./bin/activate

Once the virtual environment has been created and activated, use pip
to install Pelican and its dependencies::

    pip install pelican

If you plan on using Markdown as a markup format, you’ll need to install the Markdown library::

    pip install Markdown

Typographical enhancements can be enabled in your settings file, but
first the requisite Typogrify library must be installed::

    pip install typogrify


Installing Pelican project template
===================================

To kick start your website development we have created a Pelican theme
and project template with example content. While you can install the
template anywhere you like, for this example, clone the
cwi-pelican-template in the root of your Pelican virtual
environment. Don't forget to use your own username in the url::

    git clone https://<username>@scm.cwi.nl/ITF/cwi-pelican-template cwi


Installing the Pelican CWI theme
================================

The Pelican CWI project uses the corresponding CWI theme, but it must
be installed before Pelican can use it::

    pelican-theme --symlink ${PWD}/cwi/theme/cwi


Usage
=====

To generate html output, go to the project directory and invoke Pelican via make::

    cd cwi/projects/cwi
    make html