Local Development #

(anyone)

When cloning the repository you need to clone it recursively so that the theme submodule gets included:

git clone --recursive https://github.com/luanti-org/dev.luanti.org

If you have already cloned you can fetch the submodules as such:

git submodule init
git submodule update --remote

This project uses Hugo to build the site and various Node packages to test it.

You can install Hugo locally as a Node.js package for convenience. Node is also used for further testing scripts, like spell-checking and a11y. These scripts are described in package.json and readme.md.

To install and run via Node:

npm install # Installs packages needed to build and test the site
npm start # Builds and serves the site on a localhost port for manual testing

If you prefer, you can manually install the relevant “extended” release globally from Installation | Hugo. Be sure to match the version present in hugo.yaml.

To run globally:

hugo server # This is the command internal to the `npm start` command

Spellchecker #

You can disable the spell checker with Hugo comments:

This text is spell-checked.




The text is not splel-checked ;)




Finally, this text is spell-checked again.