- Hugo (version >= 0.109.0 extended), see this installation guide.
- Git, see this installation guide.
- Go (version >= 1.19), see this installation guide.
- Node.js (version >= 20.5.0) with npm (version >= 9.8.0), see this installation guide.
Third-party dependencies are managed using npm
and listed in
the devDependencies
block of package.json
file.
-
To update dependencies, adjust version numbers in the
devDependencies
bloc and execute the following command from project'sv4
folder:$ npm run update-deps
-
To add a new dependency, add it to the
devDependencies
bloc and execute thenpm run update-dep
command. Then, examine the location of the new dependency's CSS and JavaScript files in thev4/node_modules
folder. Dependencies, namely CSS and JavaScript artifacts must be copied from thev4/node_modules
folder to thev4/assets/sass/_vendor
andv4/assets/js/_vendor
folders, respectively. Therefore, update thev4/scripts/update-node-deps.sh
script and execute thenpm run update-dep
command again. For the newly copied SCSS and JavaScript artifacts to be used by Hugo pipes, they should be included in thev4/assets/sass/theme.scss
andv4/layouts/partials/js.html
files. Therefore, update these files accordingly, and commit the changes.
-
To build the example site, execute the
npm run build-example
command. Then, examine the content of thev4/tests/local/exampleSite/public
folder. -
To run the example site, execute the
npm run serve-example
command. The example site will be available at http://localhost:1313/. -
To stop all instances of the Hugo server running in your local dev, you may use the
npm run stop-hugo
command.