Vitrinev1.0.4

Front matter

The keys Vitrine reads at the top of a page, and the start page’s own.

Every page

KeyWhat it does
titlethe page’s heading, its name in the browser tab and, unless linkTitle is set, in the sidebar, breadcrumbs and pager
linkTitlea shorter name for the sidebar, breadcrumbs, pager and tabs
weightthe order among its siblings: lower first; pages without one come last
leadthe line under the title, in Markdown; also the page’s description and its summary in lists and llms.txt
descriptionthe description for search engines and link previews, if it should differ from lead
mathtrue loads MathJax for this page, false keeps it off when params.math is on
drafttrue keeps the page out of the built site; hugo server -D shows it

Hugo’s own keys work as usual: date, slug, url, aliases (old addresses that redirect to the page) and build (for example build: { list: never } to keep a page out of the sidebar).

yaml
---
title: Configuration reference
linkTitle: Configuration
weight: 1
lead: Every setting, with its default.
---

The start page

content/_index.md also reads:

KeyWhat it does
factsshort labels in a row under the lead: ["4 kB gzip", "MIT"]
installa command in a code block with a copy button: npm install my-lib
actionsbuttons: a list of { label, url }; the first is filled. A url from your site is relative to its root (docs/), others are full addresses
yaml
---
title: my-lib
lead: What it does, in one or two sentences.
facts: ["4 kB gzip", "0 dependencies", "MIT"]
install: npm install my-lib
actions:
  - { label: Get started, url: docs/installation/ }
  - { label: GitHub, url: "https://github.com/you/my-lib" }
---