Metadata Reference¶
This document is the authoritative reference for every YAML metadata field used in cookbook recipes.
The recipe template defines the structure. This guide explains what each field means, when to use it, and acceptable values.
Identity¶
| Field | Purpose |
|---|---|
title |
Canonical recipe name. |
status |
draft, testing, approved, or archived. |
version |
Semantic recipe version (e.g. 1.2.0). |
Classification¶
| Field | Allowed Values |
|---|---|
category |
main-dish, side-dish, sauce, breakfast, work-box, dessert, staple |
protein |
beef, chicken, pork, seafood, turkey, vegetarian, mixed, none |
rotation_role |
weeknight-dinner, weekend-dinner, work-box, side, sauce, breakfast, company, holiday, staple |
season |
spring, summer, fall, winter, all-season |
Source¶
source– Where the recipe originated.source_url– Original reference, if applicable.
Lifecycle¶
createdlast_testedapprovedapproved_date
GitHub is the source of truth. A recipe becomes permanent when it reaches approved: true.
Website¶
Tracks publication to the MkDocs website.
publishedpublished_datecanonical_url
AnyList¶
Tracks the relationship between GitHub and AnyList.
ready– Suitable for import.imported– Imported into AnyList.imported_dateimported_version– Version currently represented in AnyList.list_namerecipe_namenotes
A recipe requires re-import whenever version is newer than imported_version.
Cooking¶
servingsprep_timecook_timetotal_timeeffortmake_ahead
Practical Use¶
work_boxleftover_qualityfreezer_friendlykid_friendly
These fields describe how the family actually uses the recipe, not how a generic cookbook might classify it.
Planned Transformation¶
The transformation block documents intentional second meals.
Fields:
has_transformationtransformation_nametransformation_typetransformation_timingtransformation_urlwork_box_friendly
A transformation is not simply leftovers—it is a planned follow-up meal.
Planning Fields¶
primary_ingredients¶
List only ingredients that drive shopping and meal planning.
equipment¶
List notable equipment required to prepare the recipe.
tags¶
Tags should improve discovery, such as:
summergrillblackstoneplanned-transformationwork-box-friendlycompany-worthy
Editorial Rules¶
- Every approved recipe should include the complete metadata block.
- Metadata should describe how the Kester family cooks, not generic cookbook assumptions.
versionand the version embedded in the recipe description must always match.- GitHub metadata is the authoritative source for recipe status and publication state.