Livemark
LivemarkMarkdown site generator

Frontmatter

Updated Apr 28, 2026

YAML frontmatter at the top of each .md file attaches metadata to an article. Every field is optional; Livemark derives sensible defaults from the file itself when a field is missing.

---
title: Getting Started
description: Your first Livemark project, in ten minutes.
icon: rocket
order: 1
group: Docs
---

Article metadata

Identity and presentation of the article.

FieldTypeDefaultPurpose
titlestringFirst # heading, else filenameBrowser tab title, article heading, navigation label.
labelstringtitleShort variant used in sidebar/breadcrumbs when title is long.
descriptionstring—<meta name="description"> and Open Graph description.
iconstringPicked from path heuristicsLucide icon name (e.g. rocket, book-open).
imagestring—Open Graph / social card image. Relative paths resolve against the file.
authorstring | string[]—One or more author names.
datestring—ISO date. Drives sort order in blog sections.
tagsstring[]—Used by blog sections to build /tags/<tag>/ pages.

How the article shows up in the left-hand navigation.

FieldTypeDefaultPurpose
ordernumber— (unordered, mid-sort)Sort position. See "Ordering rules" below.
groupstring—Contiguous root-level articles sharing the same group render under a labelled sidebar section.
sidebarbooleantrueIf false, the article is reachable by URL but hidden from nav.
tocbooleantrueIf false, suppresses the right-hand table of contents.

Ordering rules

order uses a two-region scheme:

  • Positive order sorts first, ascending (order: 1, 2, 3, …).
  • Articles with no order come next, in natural order.
  • Negative order lands at the end, with -1 last, -2 second-to-last, etc.

This lets you pin "Getting Started" at the top (order: 1) and "FAQ" at the bottom (order: -1) while leaving the middle alone.

URL

FieldTypeDefaultPurpose
pathstringSlugified filename under the project rootOverride the URL slug. Include leading/trailing slashes.

Overriding without editing

If you can't modify a file's frontmatter (for example a README.md that doubles as a GitHub landing), you can inject the same fields from livemark.config.ts via Article Patches.

See also

  • Article Sections — how order, group, and date interact with blog and changelog sections.
  • Article Patches — set frontmatter from config, without touching the file.

Built with ❤ and Livemark