Skip to content
Nuartz

Frontmatter

2026-03-01Updated 2026-11-024 min read
View Markdown

All frontmatter fields nuartz reads - title, dates, tags, aliases, draft, and more.

On this page

Every Markdown file in nuartz can include a YAML frontmatter block at the top. Frontmatter controls how the page is titled, indexed, and displayed.

Example

---
title: My Note
date: 2026-03-01
description: Shown in meta tags and under the page title.
tags:
  - example
  - reference
draft: false
aliases:
  - my note
  - mynote
summary: An even shorter one-liner for the tag/folder index cards.
---

Field reference

title

The page title shown in the browser tab, the page header, the sidebar, listings, and the graph. Defaults to the file name if omitted. Wikilinks show their target text, not this title, unless you give display text with |.

description and summary

Both are optional short texts:

  • <meta name="description">, OpenGraph, RSS, and llms.txt prefer description, then summary.
  • Note cards (home page, /notes, folder and tag listings) prefer summary, then description.
  • With neither, both fall back to an automatic excerpt of the note's first paragraphs (about 200 characters).

description is also shown under the title in the page header.

tags / tag

Tags for this page. Tags generate clickable links and appear in the tag index. A YAML list, a single value, or a comma-separated string all work, and a leading # is stripped:

tags:
  - feature
  - navigation
# or
tags: feature, navigation

You can also use inline #hashtag syntax in the body. See Tags.

aliases / alias

Alternative names for this page, in the same list formats as tags. Wikilinks that use an alias resolve to this page, and the alias also works as a URL: /my-note permanently redirects (308) to the page. Alias URLs are normalized like wikilink targets (lowercase, spaces to hyphens).

aliases:
  - wikilinks
  - double brackets

An alias is skipped as a URL when it matches a real page or folder, or when two notes claim it.

An extra URL for the page that redirects to it, handled like an alias.

date / created

Publication date, e.g. 2026-03-01. Used for sorting the home page, /notes, folder and tag listings, and RSS, and displayed in the page header. Without either field the date of the file's first git commit is used.

modified / updated / lastmod

Last-modified date, shown as "Updated" in the page header and used for the sitemap and JSON-LD. Without these fields, nuartz uses the file's last git commit, then the file modification time.

Shallow clones

Git dates need history. Shallow CI clones only see their latest commits, so set dates in frontmatter if they matter.

draft / published

draft: true or published: false (booleans or the strings "true" / "false") keeps the page off the site in every mode, including bun dev. See Private Pages.

draft: true

order

A number that places the page before higher numbers (and unnumbered pages) in the sidebar and in previous/next navigation. Date sorting in listings is unchanged.

cssclasses / cssclass

Extra CSS classes added to the page's <article> element, as in Obsidian.

toc / enableToc

Set either to false to hide the table of contents for this page.

toc: false

comments

Set to false to hide comments on this page.

Notes

Tip

All frontmatter fields are optional except in specific contexts. A file with no frontmatter at all is valid - nuartz uses the filename as the title.

Obsidian compatibility

nuartz reads the same fields Obsidian writes. If you open your content folder in Obsidian, the properties panel will display and edit these fields correctly. See Obsidian Compatibility.

Linked from (9)

Show 5 more references