diff --git a/README.md b/README.md index cda824a..055a4fb 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ However, there won't be much to look at until you add some recipes! ## Recipe file format Recipes are found in `_recipes/`, with subrecipes located in `_subrecipes/`. -Here's an example recipe, which could be saved to `_recipes/chocolate_cake.yml`: +Here's an example recipe, which could be saved to `_recipes/chocolate_cake.md`: ```yaml --- name: Chocolate cake @@ -48,7 +48,9 @@ time: 240 - `name` (string) - The displayed name of the recipe. Does not appear in the URL. - `author` (string, optional) - The author of the recipe. - `ingredients` (list) - Each entry in `ingredients` is an array consisting of up to four items: - - amount (number or array) - The amount of this item to add, e.g. `2` for 2 cups of flour. If this is `0`, the output will be e.g. "jalepeño chillis to taste" rather than "0 jalepeño chillis". If this in an array, it will be printed as `amount[0] to amount[1]`. For example, if you wanted to say "2 to 3 cups of peas", you would write `[[2, 3], peas, cups]`. + - amount (number or array) - The amount of this item to add, e.g. `2` for 2 cups of flour. + - If this is `0`, the output will be e.g. "jalepeño chillis to taste" rather than "0 jalepeño chillis". + - If this in an array, it will be printed as `amount[0] to amount[1]`. For example, if you wanted to say "2 to 3 cups of peas", you would write `[[2, 3], peas, cups]`. - ingredient name (string) - The name of the ingredient, e.g. `flour` for 2 cups of flour. - unit terminology (string, optional) - The unit that amount refers to, e.g. `cups` for 2 cups of flour. If left blank or null, as in `[1, egg]`, the output will simply be "1 egg". - optional (boolean, optional) - Whether or not this ingredient is optional. The ingredient `[1, chocolate egg, null, true]` produces "1 chocolate egg" and marks is as optional. Defaults to `false`. @@ -57,7 +59,7 @@ 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. Every recipe **must** begin and end with three dashes [to ensure that Jekyll processes it](https://jekyllrb.com/docs/front-matter/). +The recipe files are standard YAML. Every recipe **must** begin and end with three dashes [to ensure that Jekyll processes it](https://jekyllrb.com/docs/front-matter/). Jekyll only processes files with certain extensions. Even though the recipes are formatted as YAML, they can't be saved as `.yml` or `.yaml` files - they must be saved with an extension that Jekyll will process, like `.md` or `.html`. Good: ```yaml