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

pre-fabricated Pelican theme and project template with example

content. While you can install the template anywhere you like, for

this example, please clone the cwi-pelican-template Git repository in

the root of your Pelican virtual environment.

You can clone the cwi-pelican template in one of two ways. First, you

can fork the repository directly in the Rhodecode server.  Point your

browser to https://scm.cwi.nl/ITF/cwi-pelican-template, choose 'Fork'

from the options menu, rename your clone, choose your repository group

and click 'Fork this Repository.' We recommend this method since is

assures that your clone resides on CWI's Rhodecode server. Now clone

your fork to your local machine. Don't forget to use your fork's url::

    git clone https://guravage@scm.cwi.nl/ITF/cwi-pelican-template-fork cwi

Second, you can clone the template directly to your local machine::

    git clone https://guravage@scm.cwi.nl/ITF/cwi-pelican-template cwi

This clone resides on your local machine. Its origin is read-only, so

you'll have to create a remote repository somewhere and reassign your

clone's origin to point to your new remote repository before you can

push your changes. See the 'Archiving your site' section below for

instructions how to create a remote Rhodecode repository.

Installing the Pelican CWI Theme

--------------------------------

The cwi project template uses the CWI theme - included in the repository.

Install the theme so Pelican knows where to find it::

    pelican-themes --list -v

Usage

=====

To generate html output, go to the project/cwi directory and invoke

Pelican via make::

    cd cwi/projects/cwi

    make html

Previewing

----------

Pelican has its own built-in server; which you invoke with

make. Better yet, generate and serve the HTML in one command::

    make html serve

The server uses port 8000 by default. After starting the server, point

you browser to the url: http://127.0.0.1:8000/.

Customizing Configuration Settings

----------------------------------

Pelican has a plethora of setting; all configurable in file named

'pelicanconf.py.' Please refer to `the settings section

<http://docs.getpelican.com/en/3.5.0/settings.html>`_ in the Pelican

documentation.

Here is the contents of pelicanconf.py used in the cwi project

template. Observe that the 'THEME' setting is assigned the string

'cwi'::

    #!/usr/bin/env python

    # -*- coding: utf-8 -*- #

    from __future__ import unicode_literals

    AUTHOR = u'M.A. Guravage'

    SITENAME = u'CWI Pelican Template'

    SITEURL = ''

    PATH = 'content'

    TIMEZONE = 'Europe/Amsterdam'

    DEFAULT_LANG = u'en'