fnonh / BakkesModWiki.github.io

A wiki and API reference for BakkesMod Plugins

BakkesModWiki-Hugo

This is a temporary development repo for the new BakkesMod Programming Wiki!

Developer installation

1. Clone the repo
2. 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
3. Download and install Doxygen (https://www.doxygen.nl/files/doxygen-1.9.2-setup.exe) to the default location
4. In the repo root, run npm install to install the required packages
5. Generate the SDK documentation by running the command npm run sdkgen
6. Run the dev server with npm run dev
7. Optionally, build the static files for offline usage with npm run static. The finished site can be found at ./public

Updating Geekdocs version - Current v0.29.0

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