Skip to content

Include instructions for building a Hugo-based project website in the handbook

Submitted by Wayne Beaton @wbeaton

Link to original bug (#538665)

Description

Cribbed from a thread on the incubation mailing list:

-- I recommend using our eclipsefdn-hugo-solstice-theme to get started since it includes all the Eclipse Foundation project website requirements such as our cookie consent banner and our google tag manager ID.

Hugo is very flexible content management system. For example, iot.eclipse.org is now built using our eclipsefdn-hugo-solstice-theme without the usual EF look and feel.

If you are looking for example on how to setup your project, I would recommend taking a look at the following website git repos: jakarta.ee https://github.com/jakartaee/jakartaee.github.io iot.eclipse.org https://github.com/EclipseFdn/iot.eclipse.org Our Hugo projects are using NPM to manage dependencies, such as our theme: https://www.npmjs.com/package/eclipsefdn-hugo-solstice-theme

You can install the latest version of the theme via the following command: npm install eclipsefdn-hugo-solstice-theme --save

The source code of our theme includes a website example via the exampleSite folder: https://github.com/EclipseFdn/hugo-solstice-theme/tree/master/exampleSite

If you chose to install our theme using NPM, you will need to update the themeDir variable in your config.toml file to let Hugo know where to find your theme:

themesDir = "node_modules/"