View of /README

Description
--------------------
sitegen is a flexible shell script for building a blog out of data stored in
flat text files.

How it works
--------------------
Entries are stored in the entries/ directory with names following the format:
entry$num.txt where $num is a sequentially assigned entry number. It's up to you
to figure out how which number comes next. An entry file looks like this:

July 1, 2006 - 7:54 PM
This is a subject
<p>If you're creating an emo blog, you might want to start by complaining about
&quot;the man&quot; keeping you down.</p>

That's it. Nothing special. Keep in mind that these fields will simply be
inserted into the proper sections of the XHTML and RSS documents respectively.
The drawback to this is that the date will never be formatted correctly for RSS.
If you want to fix it and write a patch, be my guest. There is a script called
newentry.sh that will just output the date and time so that you can redirect it
to the new filename and not have to look at the clock :)

So, the buildsite script loops through every file in the entries/ directory and
builds a static page. To theme the blog, create a dummy page that looks like
resources/template.html. Take everything you want included before the actual
entry and put it in resources/header.lres. Everything following the entry goes
in a resources/*.res file. The files will be appended in the order that bash
lists them. To keep them in a specific order, prefix the files with sequential
numbers.

Good practice would probably dicatate that you keep each separate component of
the page in a separate file. For instance, all of the 'blocks' on the sidebar
of my site are separate.

rss_footer.res and rss_header.res set the static pieces of the RSS document up.

If you wish to add a static page to your site and use the same layout the rest
of the blog uses, run the newpage script with an argument specifying the name of
the file you want to create. Example:
./newpage code.html

... Would generate a new page using the blog resources and store it in code.html
You need to edit the sitedir variable in this script for things to work right.

The sitemap/ directory contains Google's sitemap utility... You should probably
configure this.

License
--------------------
Copyright 2006 Jeremy Grosser. All rights reserved.
See the LICENSE file for details.