How to format and structure a recipe YAML file in the OpenCookbook repository. Use this skill when writing, editing, or reviewing any recipe file. Covers every field, unit rule, and file convention.
This skill tells you the exact format for recipe files. Follow every rule below.
Use this when you are:
All recipes are YAML files with the .yaml extension.
NEVER create a recipe as a Markdown (.md) file.
NEVER create a recipe as JSON, TOML, or any other format.
Every recipe file must have ALL of these fields:
| Field | Type | Example | Notes |
|---|---|---|---|
name| string |
Chicken Shawarma |
| Descriptive name of the dish |
version | string | "1.0" | Must be quoted — "1.0" not 1.0 |
author | string | Jonathan Petz | JPEGtheDev | Format: Full Name | Handle |
description | string | A spiced buttermilk... | 1–3 sentences. Use > for multiline. |
status | string | beta | One of: stable, beta, draft |
ingredients | list | (see below) | At least one group with at least one item |
instructions | list | (see below) | At least one section (unless status: draft) |
| Field | Type | When to Use |
|---|---|---|
utensils | list | Equipment needed for the recipe |
related | list | Cross-links to other recipe files |
notes | list of strings | Open questions — only for beta or draft |
NEVER include a notes field on a stable recipe. Remove it before promoting.