Skip to content
Ponzu

Recipe Frontmatter

Recipe frontmatter is a YAML block at the beginning of a recipe file that contains structured metadata about the recipe. All frontmatter fields are optional.

Frontmatter Structure

Section titled “Frontmatter Structure”

Frontmatter is defined between two lines of three dashes (---) at the start of a Markdown file:

---
title: Recipe Name
servings: 4
time: 30 minutes
source: https://example.com/recipe
tags: [dinner, quick, vegetarian]
---


# Recipe content starts here...

Supported Fields

Section titled “Supported Fields”

title

Section titled “title”

Type: String

The name of the recipe. This is how Ponzu refers to the recipe in the list view.

If title is not present in the frontmatter, Ponzu will look for a top-level header (# Header) in the recipe contents and use that for the title instead.

title: Homemade Pizza Dough

servings

Section titled “servings”

Type: Integer

The number of servings the recipe yields.

servings: 6

source

Section titled “source”

Type: String

The original source of the recipe. This can be a URL, book title, person’s name, or any other attribution.

Examples:

source: https://www.example.com/recipes/pasta
source: Joy of Cooking, p. 234
source: Grandma's recipe book

tags

Section titled “tags”

Type: List of strings

A list of tags to categorize and organize the recipe. Tags are open-ended and can be anything meaningful to you.

Examples:

tags: dinner, Mexican, vegetarian

You can also specify tags with a bulleted list, if you prefer:

---
title: Margherita Pizza
tags:
  - pizza
  - italian
  - vegetarian
---

Some additional notes on how Ponzu detects tags:

  • Commas are delimiters. Tags on a single line are separated by commas, so the tags themselves cannot contain a comma. The bulleted list format has no such restriction.
  • Spaces are allowed. quick meals, gluten free, and under 30 min are all valid.

time

Section titled “time”

Type: String

Time required to prepare and/or cook the recipe. The format is open-ended and can be expressed in whatever way makes sense for your recipe.

Example:

time: 30 minutes
time: 1 hour 15 minutes
time: 2-3 hours
time: Prep 20m, Cook 45m

Complete Example

Section titled “Complete Example”
---
title: Quick Marinara Sauce
servings: 4
time: 25 minutes
source: https://cooking.example.com/marinara
tags: [sauce, italian, vegetarian, quick]
---


## Ingredients


- 2 cans whole tomatoes
- 4 cloves garlic
- Fresh basil
- Olive oil
- Salt and pepper


## Instructions


1. Heat olive oil in a pan...