Skip to content

Commit 76c507c

Browse files
committed
update documentation
1 parent 951941d commit 76c507c

3 files changed

Lines changed: 23 additions & 16 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,33 @@ URLs have changed! Instead of finding recipes as such: `https://foss.cooking/rec
1717
* The author line should match the parent's folder's name.
1818
4. Place any pictures in the `webp` format in `/public/pix/`
1919

20+
Final result:
21+
22+
```txt
23+
.../recipes/
24+
└── your-name/
25+
β”œβ”€β”€ dish-name.md
26+
└── author.json (optional)
27+
```
28+
2029
### Templates
2130

31+
The recipe schema is as follows:
32+
```markdown
33+
// a-nice-name.md
34+
---
35+
title: "A nice name"
36+
date: YYYY-MM-DD
37+
tags: ["array", "of", "strings"]
38+
---
39+
40+
Your pretty markdown!
41+
```
42+
43+
---
44+
2245
`author.json` Follows the following schema:
2346
```json
24-
// your-name.json
2547
{
2648
"name": "Your Name",
2749
"website_tor": "url | null",
@@ -34,16 +56,3 @@ URLs have changed! Instead of finding recipes as such: `https://foss.cooking/rec
3456
}
3557
```
3658
If you want another field just let me know in an issue or PR.
37-
38-
The recipe schema is as follows:
39-
```markdown
40-
// a-nice-name.md
41-
---
42-
title: "A nice name"
43-
date: YYYY-MM-DD
44-
tags: ["array", "of", "strings"]
45-
author: "Your Name"
46-
---
47-
48-
Your pretty markdown!
49-
```

β€Žtemplate/dish-name.mdβ€Ž

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: "Dish Name"
33
date: YYYY-MM-DD
44
tags: ['different', 'tags']
5-
author: "your-name"
6-
# Author isn't actually what get's displayed, its just a key for linking to your-name.json, where your actual name is stored.
75
---
86

97
1-2 sentences about the dish.

0 commit comments

Comments
Β (0)