Reference

Use this page for compact pointers while keeping the lesson repository thin.

Start with shared docs

Shared module docs: hugo-styles
Authoring model: Authoring Guide
Curated advanced features: Hextra Features for Physics Lessons
Updates and release workflow: Updating Downstream Lessons

Why `_vendor/` exists

This template commits _vendor/ so lesson authors can run hugo server without Go installed. The vendored tree contains the shared hugo-styles module and its theme dependency at pinned versions from go.mod.

Refresh `_vendor/`

Using GitHub Actions (no local Go required)

In this repository, run the Refresh vendored Hugo modules workflow from the Actions tab. It updates the pinned hugo-styles release, refreshes the synced maintainer files, refreshes _vendor/, and then opens a pull request if anything changed.

Locally (with Go installed)

hugo mod get -u github.com/oer-particle-physics/hugo-styles@latest
hugo mod tidy
./scripts/sync-template-files.sh
hugo mod vendor
hugo --gc --minify

Commit go.mod, go.sum, the synced maintainer files, and _vendor/ together.

Small copy-paste examples

LaTeX notation

Inline: \(p_T > 25\,\mathrm{GeV}\)

$$
N_{\text{sig}} = N_{\text{obs}} - N_{\text{bkg}}
$$

Mermaid flow

```mermaid
flowchart LR
  A[Reconstruction] --> B[Selection]
  B --> C[Signal region]
  B --> D[Control region]
```

Shell tabs

{{< tabs >}}
{{< tab name="bash" selected=true >}}
```bash
hugo server
```
{{< /tab >}}
{{< tab name="zsh" >}}
```zsh
hugo server
```
{{< /tab >}}
{{< /tabs >}}

Keep this page short. Put detailed feature walkthroughs in hugo-styles so downstream lesson repositories do not carry framework documentation.