A place for mom to keep and share all her recipes 🥘. To use the site, you just need to know how to do three things:
- ✍️ create a new recipe,
- 📲 publish a recipe,
- 🖋 and edit or delete a recipe.
Below is how to do each of those in 5 steps (and a markdown cheatsheet for mom 😗).
- Go to the recipes folder. All recipes are stored here.
- At the top right, click on
Add file > Create new file
. - At the top, enter the name of the dish then
.md
to say you're making a markdown file. (For example,shepards-pie.md
. Make sure there are no spaces). - As you're writing the recipe, check the
Preview
tab to see roughly how the recipe will look. - Click
Commit new file
at the bottom. (Don't fill out the two text boxes above this button because they are optional).
- Go to the recipes folder.
- Click on the published recipes file
published_recipes.md
- Click on the pencil ✏️ at the top right to edit.
- When adding a new recipe, follow this template (The ID must be the same as the recipe's file name. If the file is named
shepards-pie.md
, the ID must beshepards-pie
. If you don't want tags, don't include the entire third line):
# Shepard's Pie
- id: shepards-pie
- tags: veggie, vegan, pie, gluten free
- Click
Commit changes
to save.
- Go to the recipes folder.
- Click on a recipe.
- Click on the pencil ✏️ at the top right to edit or click on the trash can 🗑 to delete.
- Hit
Commit changes
at the bottom to confirm the changes. - If you deleted a recipe, go back to the published recipes file and delete the recipe.
Element | Markdown Syntax |
---|---|
Recipe name | # Burgers |
Cover image | ![cover image](https://www.food.com/burgers.png) text in the square brackets must say "cover image" |
Section title | ## Ingredients |
Smaller titles | ### Small title #### Smaller title ##### Even smaller title |
Bold | **bold text** |
Italics | *italicized text* |
Strikethrough | ~~crossed out text~~ |
Ordered list | 1. First item 2. Second item 3. Third item |
Unodrdered list | - First item - Second item - Third item |
Link | [shown text](https://www.example.com) |
Measurement | `100deg` |