Note: This is my modified version for personal use. The original description is maintained below.

Rippledoc produces easily-navigable html docs from nested directories of markdown files (using Pandoc for the heavy lifting). It requires no configuration, and only requires you follow a couple of conventions described below.

Rippledoc generates a not-especially-ordered top-level table of contents for you, as well as little directory listing toc files for each subdirectory.

Rippledoc is written in Perl 5.

Given this:

docs/
    index.md
    foo/
        bar.md
        baz.md
        moo/
            aa.md
            bb.md
    zz.md

Rippledoc produces this:

docs/
    index.md
    index.html
    toc.md
    toc.html
    foo/
        toc.md
        toc.html
        bar.md
        bar.html
        baz.md
        baz.html
        moo/
            toc.md
            toc.html
            aa.md
            aa.html
            bb.md
            bb.html
    zz.md
    zz.html

Some of my own misc notes.

Prerequisites:

• A relatively recent Perl 5
• The following Perl 5 modules: Modern::Perl File::Slurp
• a fairly recent version of Pandoc

Just put the rippledoc.pl script somewhere on your PATH and make sure it's executable (chmod +x rippledoc.pl).

Run the script from a directory containing docs.

• If you have a top-level file named "_copyright", rippledoc will include its contents in the footer of every generated html file.

• You must have a top-level "index.md" file, and its first line must be like "% Name of this doc project".

• All other .md files must have their first line be like "% Title of this doc".

• Don't create any toc.md files anywhere. Rippledoc takes care of that. If you create any, they will be overwritten.

• Currently, this program doesn't provide any manual control of the ordering of items in the table of contents.

• Currently, this program quietly re-generates all table-of-contents files upon every run.

Copyright 2013 John Gabriele

Distributed under the GNU GPL v3 or later (see COPYING for details).