kmucms/dokudoku

There is no license information available for the latest version (dev-main) of this package.

dokumenting software architecture

dev-main 2026-05-16 10:37 UTC

Requires

• parsedown/parsedown: ^1.7

Unknown License

README

An folder with markdown documents (*.md) is turned to a web-page. Folders plus Filename represents the path. A navigation tree is generated.

I wrote a small lib for documenting software, so there are some special enhantments (code highlighting and graph drawing).

Installation

get the lib:

composer require kmucms/dokudoku

create index.php and put following code:

require_once __DIR__ . '/vendor/autoload.php';
$d = new \kmucms\Dokudoku\DokuDoku(); // create new instance
$d->setMdDocsPath(__DIR__ . '/docsmd/'); // *important* provide path with md-files
$d->go();

run webserver

php -S localhost:8000 

and browser

http://localhost:8000

Used Libraries

There are libraries (mermaidjs, prismjs, bootstrap) which are loaded from cdn.jsdelivr.net, so you have to be online or you can install it locally.

$d = new \kmucms\Dokudoku\DokuDoku();
$d->setConfiguration('css', ['/your/path.css']);
$d->setConfiguration('js', ['/your/path.js']);
$d->go();

Usage

There is an internal help page.

http://localhost:8000?doc=dokudoku_edit_help