========
README
========
What's here
===========
``README``
This file.
``compile.sh``
The script that compiles into a bunch of static web pages in a
web root directory ``compiled_site``.
``testhttpserver.py``
A "webserver" that you can run locally that's set up to test a
compiled site.
``site``
The source files for building the web-site.
``config.py``
PyBlosxom configuration file.
``flavours``
Holds the templates for how things get rendered.
``plugins``
Holds the PyBlosxom plugins that are being used by this site.
``entries``
Holds blog entry content.
``pages``
Holds content that's not part of the blog.
``static``
Holds images, javascript, css, fonts, and other things.
``blog.ini`` and ``pyblosxom.cgi``
Miscellaneous PyBlosxom files.
``htaccess``
This is the htaccess file for the site. Generally, lave it alone if
you don't know what it is. We're currently using it for doing the
HTTP redirects between the old site's pages and the new site's pages.
Writing a new entry
===================
A blog entry consists of a single file in ``site/entries/news/``.
Each blog entry is a separate file. The file name extension dictates how
the file is parsed. Files ending in ``.rst`` are parsed as Restructured
Text and files ending in ``.html`` are in HTML.
The structure of the file goes like this:
* first line is the title of the blog entry
* then zero or more lines of metadata
* then the blog entry body
Here's a template to use::