This is a demo announcement, dismissible and configured in site.json.
Switch to latest

Installation

Add the Bora theme to a new or existing Hugo project.

Requirements

  • Hugo v0.141.0 or later (standard build, extended is not required)
  • Dart Sass on the build machine (the theme compiles SCSS with the dartsass transpiler)

Tip

Install Dart Sass once per machine/CI image: download a release from sass-lang.com/dart-sass and put sass on the PATH. Node.js is not required. All JavaScript is pre-bundled in the theme.

If your site is not already a Hugo module, initialise it first:

bash 
hugo mod init gitlab.com/your-org/your-docs-site

Add the theme as a dependency in hugo.toml:

hugo.tomltoml 
[module]
  [[module.imports]]
    path = "gitlab.com/natitec_public/bora"

Download the module:

bash 
hugo mod get gitlab.com/natitec_public/bora

Option 2: Git submodule

bash 
git submodule add https://gitlab.com/natitec_public/bora.git themes/bora
hugo.tomltoml 
theme = "bora"

Required site files

The theme reads two files from your site root (next to hugo.toml):

file purpose
site.json titles, logo, themes, menus, footer. The theme’s configuration (reference)
static/versions.json minimal version manifest for local development. In production the release pipeline generates it from git tags (versioning)

Your hugo.toml also needs a few output-format blocks. The Hugo configuration page has the complete copy-paste setup.

Important

Without site.json the build stops with a clear error. The fastest start is copying the exampleSite/ directory from the theme repository, which is the site you are reading right now.

Continue with the Quickstart.

Edit this page