This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.


How to edit the documentation

1 - Local Hugo Docsy

How to edit the documentation

Local Hugo Docsy in Linux and WSL2

Local Hugo Docsy in Windows

Clone repository

Using SSH

git clone --recurse-submodules

or Https:

git clone --recurse-submodules

If you cloned without –recurse-submodules

Run the following command to pull submodules

git submodule update --init --recursive --remote

Download Hugo binary

Hugo releases are on

Download latest version of hugo extended

e.g. for windows:

Start local hugo server

Extract hugo binary (hugo.exe) to your dir

Run server for windows: .\hugo.exe server --disableFastRender

Once started, dev website will be accessible via http://localhost:1313

Update docsy theme submodule

git submodule update --remote
git add themes/
git commit -m "Updating theme submodule"
git push origin main