aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
blob: 9ed75c10b57580129e6e3c023c2c72e81ac75763 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Building the documentation

1. Get [hotdoc](https://hotdoc.github.io/installing.html) (0.8.9 required)
1. Run hotdoc in the docs/ directory:

    hotdoc run

## Upload

We are using the git-upload hotdoc plugin which basically
removes the html pages and replaces with the new content.

You can simply run:

    hotdoc run --git-upload-activate