BakkesModWiki-Hugo

This is the development repo for the BakkesMod Programming Wiki!

Developer installation

Clone the repo
Ensure that you have a hugo.exe binary in the root of the repo. This is needed to run the dev server and build the static website. Download instructions are available at gohugo.io
Download and install Doxygen (https://www.doxygen.nl/files/doxygen-1.9.2-setup.exe) to the default location
In the repo root, run npm install to install the required packages
Generate the SDK documentation by running the command npm run sdkgen
Run the dev server with npm run dev
Optionally, build the static files for offline usage with npm run static. The finished site can be found at ./public

Download and extract the latest version of the Geekdocs template
https://github.com/thegeeklab/hugo-geekdoc/releases
Replace the files in /themes/hugo-geekdoc with the new version
Remove the svg favicon option from
/themes/hugo-geekdoc/layouts/partials/head/favicons.html
Ensure that the page author markdown is untouched in themes\hugo-geekdoc\layouts_default\single.html
Check for any breaking changes in previous releases and fix accordingly
Update the version listed in this README
Push new version