Skip to content

Markdown versions of all docs pages are available by appending .md to any docs URL.

docs-theme-extras

Page as Markdown

A Hugo theme module that overlays Hextra with the shortcodes, partials, and CSS shared across Solo’s documentation sites.

docs-theme-extras is a Hugo theme module that overlays Hextra with the shortcodes, partials, and CSS shared across Solo’s documentation sites, plus a bundled Playwright harness that any consumer repo can re-run against its own built output.

This site is for people who use the module: content authors writing pages against it, and maintainers wiring it into a consumer repo. Documentation for changing the module itself stays in the repo, in MAINTAINING.md and OVERRIDES.md.

Important

This site is built from main, not from the latest tag. It can describe a shortcode or a parameter that no released version ships yet. Check the changelog for the version a behavior landed in, and check which version your repo pins.

Pin the module

A consumer imports the module through go.mod and Hextra arrives as a transitive dependency, so there is one pin to manage, not two.

# hugo.toml
[module]
  [[module.imports]]
    path = "github.com/solo-io/docs-theme-extras"

[params.themeExtras]
  brand = "oss"   # or "enterprise"
hugo mod get github.com/solo-io/docs-theme-extras@v1.0.0

Warning

Never run hugo mod tidy to move a pin. It deletes the require block outright rather than rewriting it. Use hugo mod get with an explicit version.

The brand flag is the only required parameter. It selects which of the two brand CSS layers loads on top of the component baseline; everything else has a working default.

Where to start

  • Writing content against the module — start with call form, which trips up more people than any single shortcode, then browse the shortcode reference.
  • Wiring the module into a repo — start with pinning the version above, then the .docs-test.toml contract.
  • Changing the module — you want the repo, not this site.
Was this page helpful?