Overview

RDocSite is a tool to create websites. Several mechanisms are provided to allow you to concentrate on the contents:

• a site is a collection of nodes. Links are managed by RDocSite in a way similar to many wikis: you can for instance use WikiNames
• you can use the familiar RDoc markup
• several plugins automate table of contents generation, sitemap creation…
• it is possible to make blog-like sites statically, with the associated RSS feeds. Adding an entry to the weblog is as easy as creating a file in a given subdirectory. A site can have several blog-like subsites, and weblog entries can be archived in the regular part of the site just by moving the associated files.

Download

The code has been hidden for long in thekode.net/misc. It’s now officially released as 0.0.1RC3: rdocsite-0.0.1rc3b.tar.gz. I tend to use very low version numbers, despite being 0.0.1, it’s AFAIK reasonably bug-free (a couple active users for several months, it’s been a long time since I had a bug report), and the documentation is fairly OK. However, it’s not polished, in the sense that it is sometimes assumed that you understand how it works (for instance, when an error occurs while processing a node, rdocsite will terminate & show the exception, instead of rescueing and printing a friendly message).

Documentation

It is included in the tarball (the docs are written in rdocsite and will be built on install).

Here’s a copy of the docs included with the sources:

• RDocSiteProcessingOverview
• RDocSitePluginReference
• RDocSiteMarkup

License

I’m using Ruby’s for your/my convenience. I’m no license facist.