Static documentation site for pledger.io, built with Hugo Extended and the Hinode theme.
- Hugo Extended 0.163.1 or newer
- Go (for Hugo modules)
- PowerShell (to regenerate release notes)
# Install theme modules
hugo mod get
# Regenerate release pages from source (required before first build)
pwsh scripts/generate-releases.ps1
# Bundle the OpenAPI spec for the interactive API reference page
pwsh scripts/bundle-openapi.ps1
# Preview with drafts
hugo server -D
# Production build
hugo --gc --minify| Path | Purpose |
|---|---|
content/ |
Documentation pages (Markdown) |
config/_default/ |
Hugo and theme configuration |
data/*.yaml |
Sidebar navigation per section |
layouts/ |
Theme overrides |
assets/img/ |
Logos and screenshots |
static/openapi/ |
OpenAPI specification (split source files) |
scripts/bundle-openapi.ps1 |
Bundles OpenAPI into static/openapi/openapi.bundle.yaml |
scripts/releases-source.md |
Source for release notes |
scripts/generate-releases.ps1 |
Generates content/releases/ and data/releases-*.yaml |
Generated release files (content/releases/, data/releases-*.yaml) are not committed; CI and local builds run the generator first.
GitHub Actions workflows:
| Workflow | Trigger | Purpose |
|---|---|---|
build-documentation.yml |
Pull requests | Build Hugo site, check links, upload artifact |
deployment.yml |
Push to master |
Build and deploy to Azure Static Web Apps |
On every pull request to main/master, the site is built and internal links are checked with lychee.
On push to master, the built site is deployed to Azure Static Web Apps using PLEDGER_WEB_DEPLOY_TOKEN (same setup as the existing deployment workflow).
PLEDGER_WEB_DEPLOY_TOKEN— Azure Static Web Apps deployment token
- Edit
scripts/releases-source.md - Run
pwsh scripts/generate-releases.ps1 - Commit only
scripts/releases-source.md(generated files are recreated in CI)
Version headings: ## 5.1.0 or == 5.1.0. Section headings: ### / ==== or === / ====.