BluBracket documentation website https://docs.blubracket.com .

This repo uses Hugo, a static site generator written in Golang, and the Doks theme.

Hugo has its own documentation for the template structure, functions, variables, and more. The Doks theme extends Hugo in an opinionated way that uses Node.js and npm to automate the few things that Hugo left undone.

This theme is automated using Node.js and npm.

Follow the lastest docs for setup on the NVM repo

Then run:

nvm --version

If you're seeing a command about NVM not found, add this to your terminal profile:

export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

Then reload the terminal source (or open a new terminal tab).

nvm install v14.21.2

npm install

npm run start

Then visit http://localhost:1313 to see the generated website.

Hugo will remain running, watch for updates to any files, and re-render them as needed.

Any template changes leading to syntax or other execution errors will require restarting the preview server.

Generally, the website is built as part of the GitHub Actions CI/CD workflow, however it can be run manually:

npm run build

In normal usage, that action should automatically build and push any changes to the main branch.

In normal usage, tests are run on every pull request from the GitHub Actions CI workflow. However, tests can also be run manually:

npm test

The extent of testing is currently limited to ensuring the JS integrates cleanly. It does not meaningfully test the templates or any aspect of the site content.

The theme in this repo is based on https://github.com/h-enk/doks by Henk Verlinde and used under the terms of the MIT license.