Documentation on Nimbus

Getting Started

Fri, 01 Mar 2024 00:00:00 +0000

Prerequisites

Hugo Extended ≥ 0.146.0 — check with hugo version.
Node.js (any recent LTS) — needed for the Tailwind/PostCSS build step.

Run the example site

The example site lives in exampleSite/ and references the theme one directory up, so it’s built with the --themesDir flag rather than a copy of the theme inside it:

1
2
3
4


git clone https://github.com/your-org/hugo-theme-nimbus.git
cd hugo-theme-nimbus/exampleSite
npm install
hugo server -D --themesDir ../..

Open http://localhost:1313 to see it running.

Installation

Tue, 05 Mar 2024 00:00:00 +0000

1. Add the theme

As a Git submodule (recommended for most sites):

1

git submodule add https://github.com/your-org/hugo-theme-nimbus.git themes/nimbus

Or as a Hugo Module:

1
2


hugo mod init github.com/you/your-site
hugo mod get github.com/your-org/hugo-theme-nimbus

2. Point your site config at it

1

theme = "nimbus"

3. Copy the build tooling

Nimbus’s styling is compiled with Tailwind, ahead of time, into a plain CSS file — Hugo itself never runs Node or PostCSS. Copy these files from exampleSite/ into your site root:

Shortcodes

Fri, 12 Apr 2024 00:00:00 +0000

Note boxes

type can be info (default), warning, success, or error.

1
2
3


{{< note type="tip" title="Pro tip" >}}
Your content here.
{{< /note >}}

Pro tip

type can also be passed positionally, but not combined with title= in the same call — Hugo rejects mixing positional and named arguments.

Terminal

1
2
3


{{< terminal command="bash" user="dev" host="prod-01" path="~/app" >}}
kubectl get pods
{{< /terminal >}}

bash

dev@prod-01:~/app$

kubectl get pods NAME READY STATUS RESTARTS AGE api-7d8f9c6b5d-x2k9p 1/1 Running 0 3m

Badges

1
2


{{< badge "kubernetes" "Kubernetes v1.28" >}}
{{< badge type="terraform" label="Terraform v1.5" url="https://terraform.io" >}}

Kubernetes v1.28 Docker Terraform v1.5 AWS

API Reference

Mon, 20 May 2024 00:00:00 +0000

This page is rendered entirely from the openapi.yaml file sitting next to it in this page bundle — no separate Swagger UI build step, no JS widget to keep updated, just Hugo parsing the spec at build time.

Deploys API

v1.0

Trigger and inspect deployments for a service.