Source

build-wiki /

Filename Size Date modified Message
68 B
2.1 KB
2.1 KB
230 B

Wikibuilder

Synopsis

The wikbuilder creates a static (html-)website from a directory containing plain text files with Creole wiki markup.

Application

I maintain a personal knowledgebase (kb). This kb consists of a mercurial (hg) repository (with code snippets and such) and a wiki, both hosted on Bitbucket in a private repo. A Bitbucket wiki, is backed by a hg repository itself. This allows me to keep a local versioned, editable and searchable version of my kb wiki.

Locally, I use a text editor to edit the wiki pages. I use the wikibuilder to create a a local, browsable kb website. This allows me to browse my mind, in a sense.

Design

The wikibuilder is a Python script that uses Creoleparser to generate html content from the wiki source files. It duplicates directory structure of the source files and generates a html page for each wiki source file. A Genshi template is used to generate the html pages.

Dependencies

easy_install -U creoleparser

At the time of writing, I used:

  • Genshi 0.6 (dependency of Creoleparser)
  • Creoleparser 0.7.2

Only tested with Python 2.7 on Windows 7.

Alternatives

Alternatively, I could use a desktop wiki editor, that supports Creole markup.

Alternatively, I could host a wiki-engine-site (what's it called?) on my desktop, and access it with my webbrowser. This would work. MoinMoin appears to support Creole, and I might explore this in the near future. For now, I'm happy with plain text editing.

Alternatively, I could keep my entire kb in rst and use spinx to build a website and printable documentation. However, what I like about the wiki concept, is that I can easily and loosely relate and link concepts in my kb, which (I think) matches the way my brains work nicely. If I were to use Sphinx, I'm likely to over-organize things.