HEAL template

This template contains necessary assets etc for heal-styled documentation using mkdocs.

• It can be used to start a new documentation-dedicated repository or components from here can be directly copy-pasted into existing docs.
• It can also be used to test and learn mkdocs without any python required.

Run/test locally (i.e., on your computer):

pip install -r requirements.txt

mkdocs serve

Test solely via github (no python required)

change urls in the configuration file

Create a new repository on github with this template

In the mkdocs.yaml file, change the following lines:

site_url: https://norc-heal.github.io/heal-docs-template
repo_url: https://github.com/norc-heal/heal-docs-template

to

site_url: https://norc-heal.github.io/my-mkdocs-repo
repo_url: https://github.com/norc-heal/my-mkdocs-repo

where my-mkdocs-repo is the name of your newly created repository.

Change the github pages settings

We also need to specify that we want to use github pages on this repository. To do this, go to the Git hub pages settings here and select "gh-pages" under the "branches" dropdown menu.

** NOTE: if using your personal github rather than the norc-heal organization, remember to change the base of the url as well to:

site_url: https://<account name>.github.io/my-mkdocs-repo
repo_url: https://github.com/<account name>/my-mkdocs-repo