From 44cfec0496ff31c04f79be7bd181cfc4d782ca95 Mon Sep 17 00:00:00 2001 From: Lynne Date: Sun, 1 Mar 2020 07:07:20 +1000 Subject: [PATCH] update readme to reflect issue closure --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 51f9e50..31fda0d 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,18 @@ time: 240 The recipe's file name isn't important, but it's good practice to make it something obvious, like `chocolate_cake.md` and not `strawberry_pie.md`. -The recipe files are standard YAML. The extension should always be `.md` - other extensions will cause issues with subrecipes (see #1). +The recipe files are standard YAML. Every recipe **must** begin and end with three dashes to ensure that Jekyll processes it. + +Good: +```yaml +--- +name: Example +--- +``` +Bad: +```yaml +name: Example +``` ### Subrecipes Subrecipes behave a little differently to regular recipes: