Technical previewShare feedback

Frontmatter

Updated Nov 10, 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
---

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.
iconstring—Lucide icon name (e.g. rocket, book-open). Articles without an icon render with no icon at all.
imagestring—Open Graph / social card image (needs site). 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 <blog prefix>tags/<tag>/ pages, e.g. /blog/tags/release/.

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

FieldTypeDefaultPurpose
ordernumber— (unordered, mid-sort)Sort position. See "Ordering rules" below.
sidebarbooleantrueIf false, the article is reachable by URL but hidden from nav.
tocbooleantrueIf false, suppresses the right-hand table of contents.
breadcrumbsbooleanconfig breadcrumbsIf false, hides the trail above the title; true shows it even when the config turns it off.

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
pathstringThe file's folders and slugified name (see below)The article's URL. Leading and trailing slashes are added when missing.
languagestring.<code>.md file suffix, else the default languageThe article's language on a multi-language site.

Without a path, the URL comes from where the file sits below the fixed start of the include glob that matched it — docs/ for docs/**/*.md:

  • docs/guide/install.md → /guide/install/
  • docs/guide/index.md → /guide/, an index file naming its folder
  • docs/index.md → /
  • docs/guide/install.es.md → /es/guide/install/, or the original's path under /es/ when install.md sets one

Every segment is slugified, so docs/Getting Started.md becomes /getting-started/. Two articles that end up with the same path fail the build, naming both files.

The page toolbar links each article to its source. Without a sourceUrl, the link goes to the file's GitHub edit page, read from the project's git origin and default branch; a project that is not a GitHub repository shows no link.

FieldTypeDefaultPurpose
sourceUrlstringThe file's GitHub edit pageWhere the source link points.
sourceAction"edit" | "view""edit"Labels the link Edit on GitHub with a pencil, or View on GitHub with an eye.

Format

FieldTypeDefaultPurpose
format"md" | "mdx""mdx" for a .mdx file, else "md"Compiles the body as plain Markdown, or as MDX.

Plain Markdown takes any text: {…} stays literal and raw HTML renders as HTML. MDX adds JSX and {expressions}, so a stray brace or < in prose fails the build.

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 and date interact with blog and changelog sections.
  • Article Patches — set frontmatter from config, without touching the file.

Created with ❤ and Livemark