Nukumi

Nukumi is a general purpose static blogging system written in Ruby.

Nukumi is licensed under the terms of the GNU General Public License. See COPYING for details.

Nukumi -- a blogging system
Copyright (C) 2004 Christian Neukirchen

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Author

Christian Neukirchen: chneukirchen@yahoo.de

Version 0.5:

This is a pre-relase.

Thanks to Paul Battley for ideas on handling Formatters.

New features in this release:

New Formatters

Two Formatters were added. To write entries in plain XHTML, use:

Encoding: XHTML

To write preformatted text, use:

Encoding: PreFormatted

External Formatters

If you want to use an external formatter, for example RedCloth, simply use it:

Encoding: RedCloth

Nukumi will try to load redcloth.rb to access the class RedCloth. If your formatter has a name not possible to use as Encoding:, you may simply require it in the rc-file. Formatters can be overridden by defining Nukumi::Formatter::Foo.

Fixed URLs

There is a new view "Page" to support generation of pages with fixed URL. For example, a post with the line:

Page: fixedurl

will get copied to the file fixedurl.html.

Hiding pages

If you don't want to have certain pages to be shown on the Front view (by default, front page and feeds), add:

Hidden: true

This is especially useful for files with a fixed URL. You can use these features to provide a about or contact page for your weblog.

Version 0.4:

This version was never really released.

Multiple keys

For Programmers: generate_key now can return an Array of Strings to provide support for multiple keys per View.

Support for Categories

To add a file to one or several categories, put a line like this into the header:

Category: foo bar baz

This will add the post into the categories foo, bar and baz.

The posts will be grouped by category written into overviews, that is files like category-foo.html etc.

Support for Actions

The way nukumi.rb gets called has changed. If you used your own rc-file, you need to specify parameter -r now. Additionally, you can call Nukumi with an Action, for example:

nukumi.rb purge

To remove all generated pages. By default, generate is the only valid action. (But see nukumirc.)

Emacs support

There is a file nukumi.el providing an Emacs mode to help blogging.

Improved feeds

Feed support has improved a lot. RSS and Atom feeds are now fully valid and use the best current practices (afaict).

Version 0.2, 0.3:

This is a pre-relase.

In case you want to use it, you will need to adjust the files to your needs.

Version information

$Id: README 0.57 2004/08/08 17:52:23 chneukirchen devo $
arch-tag: 566bec8d-846c-4e81-bcc5-6241c66f2169