lynnesbian/recipe-site
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

fix some innacuracies in the readme
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse source
This commit is contained in:
Lynne Megido 2020-03-01 06:44:29 +10:00
parent 49141a225b
commit d5bbcb36f5
Signed by: lynnesbian
GPG key ID: F0A184B5213D9F90
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -5,6 +5,8 @@ A simple static [Jekyll](https://jekyllrb.com) site for keeping track of recipes
## Usage ## Usage
Ensure that you have [Git](https://git-scm.org), [Ruby](https://www.ruby-lang.org) and [RubyGems](https://rubygems.org/) installed. Ensure that you have [Git](https://git-scm.org), [Ruby](https://www.ruby-lang.org) and [RubyGems](https://rubygems.org/) installed.
Assuming a Unix system:
``` ```
$ git clone https://git.bune.city/lynnesbian/recipe-site $ git clone https://git.bune.city/lynnesbian/recipe-site
$ cd recipe-site $ cd recipe-site
@ -27,6 +29,7 @@ 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.yml`:
```yaml ```yaml
---
name: Chocolate cake name: Chocolate cake
author: Jane Crocker author: Jane Crocker
layout: recipe layout: recipe
@ -41,6 +44,7 @@ method:
- Whisk the egg finely - Whisk the egg finely
# et cetera # et cetera
time: 240 time: 240
---
``` ```
- `name` (string) - The displayed name of the recipe. Does not appear in the URL. - `name` (string) - The displayed name of the recipe. Does not appear in the URL.
- `author` (string, optional) - The author of the recipe. - `author` (string, optional) - The author of the recipe.
@ -49,7 +53,9 @@ time: 240
- `method` (list) - A list of steps undertaken to create the recipe, written in plain English. Or whatever language you prefer. - `method` (list) - A list of steps undertaken to create the recipe, written in plain English. Or whatever language you prefer.
- `time` (string, optional) - The time it takes to make the recipe in minutes. - `time` (string, optional) - The time it takes to make the recipe in minutes.
The recipe's file name isn't important, but it's good practice to make it something obvious, like `chocolate_cake.yml` and not `strawberry_pie.yml`. 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).
### Subrecipes ### Subrecipes
Subrecipes behave a little differently to regular recipes: Subrecipes behave a little differently to regular recipes:
@ -59,12 +65,17 @@ Subrecipes behave a little differently to regular recipes:
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: 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 ```yaml
---
name: Chocolate icing name: Chocolate icing
parents: parents:
- chocolate_cake - chocolate_cake
- chocolate_cupcakes - chocolate_cupcakes
ingredients:
- [250, chocolate, grams]
# et cetera
---
``` ```
The entries in `parents` refer to the filenames of the parent recipes - `chocolate_cake` refers to `chocolate_cake.yml`. The entries in `parents` refer to the filenames of the parent recipes - `chocolate_cake` refers to `chocolate_cake.md`.
If a subrecipe does not have at least one valid `parents` entry, it will not appear anywhere on the website. If a subrecipe does not have at least one valid `parents` entry, it will not appear anywhere on the website.