Docs

This directory contains hugo documentation to be published in Github pages.

Run Locally

hugo server -D

This will serve the docs on http://localhost:1313.

Deploy to Github Pages

Changes to the main branch will be deployed automatically with Github actions.

Update Geekdocs

The docs use the Geekdocs theme. The theme is checked in to Github in the ./docs/themes/hugo-geekdoc/ folder. To update Geekdocs, remove the current folder and create a new one with the latest release. There are no local modifications in ./docs/themes/hugo-geekdoc/.

Notes

Here's how the initial docs/ folder was set up:

hugo new site docs
cd docs/
mkdir -p themes/hugo-geekdoc/
curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/download/v0.41.1/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1

Create the initial hugo.toml file as described in https://geekdocs.de/usage/getting-started/.