Description

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.

Installing

RDocSite requires rdoc to run so please make sure you have installed it before attempting to install RDocSite itself (otherwise the documentation generation will fail).

 ruby install.rb config
 ruby install.rb setup
 ruby install.rb install

Documentation

• RDocSiteProcessingOverview
• RDocSitePluginReference
• RDocSiteMarkup

See also the list of nodes.

User visible changes

Take a look at the list, included in the sources.

Example

You can take a look at the sample site included in the documentation. Note that rdocsite allows you to customize the templates freely, so your site needs not look at all like this.

Note that the documentation itself is generated with RDocSite. Check out doc-src/ in the source code tarball.

Usage

     rdocsite [options] <source dir> <dest. dir>              standard mode
     rdocsite [options] -f <source file> [dest. dist>]        simplified mode

 Common options:
     -v, --verbose [LEVEL=1]          Show progress as nodes are processed
                                      higher means more verbose
     -w, --warning LEVEL              output messages of severity equal to
                                      or bigger than LEVEL (defaults to 2)
     -s, --silent                     sets the verbose level to -1 and
                                      warning to 1000
     -h, --help                       display this help
         --version                    display version info

 Standard mode options:
     -n, --no-copy                    don't copy data files

 Simplified mode options:
     -f, --file FILE                  process the specified file only
                                      (simplified mode)