Route Data

Every template, component, and partial receives one *RouteData value as its dot context (.). This page lists every field on it and on the types reachable from it, in the order the Go structs declare them. The source of truth is internal/engine/types_route.go and types_page.go; a test in internal/engine fails when a field is added to the structs without an entry here.

RouteData and Page are built from embedded groups, and html/template promotes embedded fields, so address them flat: .Lang, not .RouteI18n.Lang; .Page.Title, not .Page.PageIdentity.Title.

Reading this page

The Set when column on the RouteData tables says when a field holds a value. Everywhere else, assume the field is populated whenever its parent is. The conditions come from BuildRouteData in internal/template/routedata.go.

A nil pointer is false in {{ if }} but panics on field access, so guard optional pointers with with:

{{ with .Paginator }}Page {{ .Current }} of {{ .Total }}{{ end }}

RouteData

Page and site

RouteNav

RouteI18n

RouteVersioning

RouteTabs

RouteLabs

RouteAssets

Extras

Template names

.Template follows this order: the page's template frontmatter wins when set; otherwise the value depends on the page kind.

The name is then resolved through the lookup chain in Layouts and Templates.

Page

Page embeds the groups below, so their fields are addressed as .Page.<Field>. Sidebar and TOC are named fields, addressed as .Page.Sidebar.<Field> and .Page.TOC.<Field>.

PageIdentity

A time.Time is never false in {{ if }}, so guard dates explicitly:

{{ if not .Page.Date.IsZero }}<time datetime="{{ .Page.Date.Format "2006-01-02" }}">{{ .Page.Date.Format "January 2, 2006" }}</time>{{ end }}

PageContent

Internal, not for templates: ContentDigest and FrontmatterDigest are hashes used by incremental rebuilds.

PageMeta

PageRelationships

PageTaxonomy

PageSidebar (.Page.Sidebar)

Sidebar presentation settings for this page. This is not the navigation tree; that is .Sidebar on RouteData.

PageTOC (.Page.TOC)

PageI18n

PageVersioning

Direct fields and methods

SiteContext (.Site)

.Site.Config is typed any in Go to avoid an import cycle, and holds the parsed configuration at runtime. Templates read it directly, so {{ .Site.Config.Footer.Text }} works, but a misspelled section fails at render time rather than at config load. The sections the default theme reads:

Every other top-level key in Configuration is reachable the same way, by its section name in PascalCase.

LogoContext and LogoImage

LogoImage has URL, Width, and Height. Width and height are 0 for SVG logos and whenever the dimensions could not be probed.

Language

IconLicense

Collection

Internal, not for templates: CompositeNavTrees and CompositeTabSets are keyed by a language-and-version key that templates cannot compute.

CollectionConfig

SidebarConfig

TOCConfig, PrevNextConfig, LabsConfig

DocsTab

Section

Parent and Collection point back up the tree. A template that recurses through them without a stopping condition never terminates.

VersionConfig and VersionDef

VersionDef has ID, Label, Path (URL segment, defaults to ID), Banner (none, unmaintained, or unreleased), and Redirect (same-page or root).

Navigation types

NavTree

Internal, not for templates: Hash is a cache key.

NavNode

Walk Children downward only. Parent and Page.NavNode form cycles.

{{ define "navlist" }}
<ul>
  {{ range .Children }}
  <li{{ if .IsActive }} class="active"{{ else if .HasActive }} class="open"{{ end }}>
    <a href="{{ .URL }}">{{ .Label }}</a>
    {{ if .Children }}{{ template "navlist" . }}{{ end }}
  </li>
  {{ end }}
</ul>
{{ end }}
{{ with .Sidebar }}{{ template "navlist" .Root }}{{ end }}

→ A nested list of every sidebar entry, with the current page marked active and its ancestors marked open.

GlobalNav and GlobalNavItem

GlobalNav has one field, Items, a slice of GlobalNavItem.

BreadcrumbItem

PaginationLinks and PaginationLink

PaginationLinks has Prev and Next, each a *PaginationLink with URL and Title. Either side may be nil.

Paginator

Pages holds the numbered links, not the content. The content for the current page is CurrentPages. Page 1 lives at the collection URL and page N at <collection>/page/N/.

{{ $pages := .Collection.Pages }}
{{ with .Paginator }}{{ $pages = .CurrentPages }}{{ end }}
{{ range $pages }}
<article><a href="{{ .Permalink }}">{{ .Title }}</a></article>
{{ end }}
{{ with .Paginator }}
<nav>
  {{ if .HasPrev }}<a href="{{ .PrevURL }}">Newer</a>{{ end }}
  <span>{{ .Current }} / {{ .Total }}</span>
  {{ if .HasNext }}<a href="{{ .NextURL }}">Older</a>{{ end }}
</nav>
{{ end }}

→ On a paginated list, the current slice of posts and prev/next links; on an unpaginated list, every post and no nav.

Taxonomy types

Taxonomy

TaxonomyTerm

TermEntry

Embeds *TaxonomyTerm, so every field above (Name, Slug, CustomSlug, Permalink, Pages, Label, Description, Color, Icon, Hidden, Priority, Difficulty, ContentType) is available directly, plus:

Homepage types

HomepageData and HeroData

HomepageData has Template (the homepage template name) and Hero.

HeroCTAData, HeroStatData, HeroCodeData, HeroImageData

Leaf types

TranslationLink

{{ if .AllTranslations }}
<ul>
  {{ range .AllTranslations }}
  <li><a href="{{ .URL }}" hreflang="{{ .Lang }}" dir="{{ .Dir }}"{{ if eq .Lang $.Lang }} aria-current="true"{{ end }}>{{ .Name }}</a></li>
  {{ end }}
</ul>
{{ end }}

→ One link per configured language, with the current one marked.

VersionLink

Heading

Resource

Internal, not for templates: SrcPath is the absolute path on the build machine.

Badge

PageBanner

ThemeConfig (.Theme)

LayoutType and NodeKind

.Layout is one of default, docs, splash, wide, full, centered, split, presentation, or labs. Sidebar layouts are docs, wide, and labs; table-of-contents layouts are docs and labs.

.Page.Kind is one of home, section, page, bundle, standalone, taxonomy, or term.