Authoring Guide

Frontmatter rules, markdown conventions, and page metadata behavior.

Required frontmatter

For a typical recipe, each note should contain at minimum:

---
type: article
slug: my-slug
title: Clear title
---

Common optional fields:

  • description
  • draft
  • hub
  • related
  • aliases
  • noindex
  • redirect_to
  • jsonld

Draft behavior

Default is usually defined in rules (fields.defaults.draft: false).

  • With draft: true, inclusion in search/sitemap depends on rules (exclude_drafts).
  • Draft pages may exist in resolve/meta unless explicitly filtered out.

Metadata behavior

  • canonical: built automatically from site.base_url + route, unless overridden.
  • robots: built from noindex, unless explicitly set.
  • OpenGraph: built from frontmatter, content, and site defaults.
  • jsonld: embedded only when JSON is valid.

Writing practice

  • Use stable slugs and change them only with redirects.
  • In recipe templates, frontmatter title is already rendered as h1; in page body, usually start with h2 to avoid duplicate h1.
  • For predictable search snippets, fill frontmatter description: this field is used as snippet.
  • The first paragraph is useful as a concise intro and can be used as fallback for og:description, but it is not the main source for search snippet.
Все результаты