Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Docs

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

Dependencies

Run Locally

To serve the documentation locally, run the following command:

hugo server -D

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

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/.

rm -rf ./docs/themes/hugo-geekdoc mkdir -p themes/hugo-geekdoc/ curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1

Deploy to Github Pages

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