update readme to reflect issue closure
This commit is contained in:
parent
96fcad7f7d
commit
44cfec0496
1 changed files with 12 additions and 1 deletions
13
README.md
13
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'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
|
||||||
Subrecipes behave a little differently to regular recipes:
|
Subrecipes behave a little differently to regular recipes:
|
||||||
|
|
Loading…
Reference in a new issue