Setting up a project

Hotdoc can accept options both from the command line and from a json configuration file. The command line options will take precedence over their json counterpart.

To see a list of all options available (including extension's options), run:

hotdoc help

Setting up a project from scratch.

This will set up the project in the current directory:

hotdoc init --project-name test --project-version "0.1"

You can use --init-dir to specify a different directory, which will be created:

hotdoc init --init-dir test --project-name test --project-version "0.1"
cd test

Once that's done:

hotdoc run
xdg-open built_doc/html/index.html

Refer to the page creation tutorial for more information.

If you need more inspiration, check out the other projects that use hotdoc