generateSite

The generateSite task is more advanced. In many cases, your goal will not be to create a single HTML document but a whole documentation website. This is where generateSite shines. It uses a static site generator to turn your document into a nice looking microsite with landing-page, local search and edit links.

Linux / WSL2 with bash
./dtcw generateSite
Windows with Powershell
./dtcw.ps1 generateSite
output of generateSite
$ ./dtcw docker generateSite
dtcw - docToolchain wrapper V0.24
docToolchain V2.0.0

Bash is running on WSL
this might cause problems with plantUML
see https://doctoolchain.github.io/docToolchain/#wsl for more details

Java Version 11
docker available
home folder exists
force use of docker
/usr/bin/docker
use docker installation
Starting a Gradle Daemon (subsequent builds will be faster)

> Configure project :
arc42/arc42.adoc

> Task :generateSite
created
/project/build/microsite/tmp
copy internal theme /home/dtcuser/docToolchain/src/site
copy project theme /project/src/site

> Task :copyImages
> Task :bake
Warning: Nashorn engine is planned to be removed from a future JDK release

BUILD SUCCESSFUL in 1m 15s
3 actionable tasks: 3 executed

The output is written to build/microsite/output/index.html. You can open this file in your browser and view the results. But you will notice that some features which rely on javascript will be broken. To avoid this, use the task previewSite to start a little webserver which presents you the site without flaws.

generateSite
Figure 1. generated output of generateSite task