Back to page 3 pages

Referens

https://groovy.simplo.dev/produkt-a/referens

Frontmatter

https://groovy.simplo.dev/produkt-a/referens/frontmatter

Tillgängliga frontmatter-nycklar för dokumentationssidor.

Standardnycklar

Alla vanliga Grav-nycklar fungerar som vanligt, till exempel title och visible.

Temaspecifika nycklar

Under fliken Docs i Admin finns fyra tillägg.

Nyckel Typ Beskrivning
header.menu_icon text Lucide-ikonnamn bredvid menyraden, t.ex. book-open
header.description text Underrubrik och meta-beskrivning
header.nav_group boolean Rendera som icke-klickbar grupprubrik
header.toc_display on / off Visa eller dölj "På den här sidan"; ärvs av undersidor
---
title: Exempel
header:
  description: En kort undertext
  toc_display: off
---

Note

header.nav_group-sidor renderas fortfarande om de besöks direkt, men de visas som rubrik snarare än länk i menyn.

Se även Twig-variabler.

Twig-variabler

https://groovy.simplo.dev/produkt-a/referens/twig-variabler

Egna Twig-funktioner som temat tillhandahåller.

Funktioner

Temat registrerar tre egna Twig-funktioner via onTwigInitialized.

{{ docs_headings(page.content) }}
{{ page.content|docs_add_heading_ids|raw }}
{{ docs_flat_pages() }}

docs_headings

Returnerar en lista med level, id och text för varje h2/h3 i renderad HTML. Används av högerspaltens innehållsförteckning.

docs_add_heading_ids

Injicerar id="slug" i rubriktaggar som saknar id, så att länkar från innehållsförteckningen fungerar.

Globala variabler

Variabel Innehåll
page Aktuell sida
pages Sidträdets rot
theme_var('key') Temats konfigurationsvärden

Important

docs_flat_pages() bygger en djupled-först-lista av alla synliga, routbara sidor och används för föregående/nästa-länkar över sektionsgränser.