From 1620a1b7aea55f547a1fae3af9ce23d740111b5d Mon Sep 17 00:00:00 2001 From: Lynne Date: Fri, 6 Mar 2020 05:17:41 +1000 Subject: [PATCH] add a help file, expand on the readme a bit --- README.md | 6 +++--- _includes/footer.html | 2 +- help.html | 20 ++++++++++++++++++++ 3 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 help.html diff --git a/README.md b/README.md index fce10ec..51534e1 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ time: 240 - `author` (string, optional) - The author of the recipe. - `difficulty` (float, optional) - The difficulty of the recipe on a scale of 1 to 5. Will be displayed as a star rating. Half stars (e.g. "2.5") are allowed. - `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. + - amount (number or array) - The amount of this item to add, e.g. `2` for 2 cups of flour. Non-whole numbers will be displayed as fractions, e.g. `1.5` becomes `1½`. - If this is `0`, the output will be e.g. "jalepeño chillis to taste" rather than "0 jalepeño chillis". - If this is 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. @@ -61,7 +61,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/). 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`. +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`. Additionally, any tags not marked as optional **must** be included in order for the file to render properly. Good: ```yaml @@ -77,7 +77,7 @@ name: Example ### Subrecipes Subrecipes behave a little differently to regular recipes: - They don't show up on the home page -- The `time` tag is not supported +- The `time`, `author`, `difficulty` and `ratings` tags do not do anything. They can still be included, but won't be displayed. Subrecipes have a tag that regular recipes do not - the `parents` tag. This is a list of recipes that the subrecipe should be included in. For example: ```yaml diff --git a/_includes/footer.html b/_includes/footer.html index d08e0bf..94928fe 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,4 +1,4 @@ diff --git a/help.html b/help.html new file mode 100644 index 0000000..ee19587 --- /dev/null +++ b/help.html @@ -0,0 +1,20 @@ +--- +title: Help +layout: default +--- +

Using the site

+

+ Here are a few tips and tricks you might find useful: +

+ +

Creating recipes

+

+ You can create your own recipe by placing a properly formatted file in the _recipes directory in the Jekyll project folder. Note that creating recipes through the web UI is not possible. +

+

+ For information about the recipe format, subrecipes, and more, see the README. +