A repository of family recipes that can be updated, modified, forked, or branched to create delicious variants. This site is built using MkDocs to display recipes in an organized, searchable format.
Recipes are organized by category in the docs
directory:
appetizers
: Dips, starters, and small bitesbreakfast
: Morning meals and brunch itemsdessert
: Sweet treats and confectionsdinner
: Main courses and entreesgluten_free
: Recipes without glutensauces
: Dressings, sauces, and condimentsside_dishes
: Accompaniments and side dishessmoked_foods
: Smoked and cured recipes
To add a new recipe:
- Create a markdown (.md) file in the appropriate category folder
- Use a clear, descriptive name for the file (e.g.,
Chocolate Chip Cookies.md
) - Follow the recipe template format below
# Recipe Name
## Description
A brief description of the dish, its origins, or special notes.
## Ingredients
- 2 cups ingredient one
- 1 tsp ingredient two
- 3 tbsp ingredient three
## Instructions
1. First step in the process
2. Second step in the process
3. Continue with numbered steps
## Notes (optional)
- Preparation time: 20 minutes
- Cooking time: 45 minutes
- Serves: 4 people
- Any substitutions or variations
Markdown formatting reference:
# Main Heading
## Subheading
### Smaller Heading
- Bulleted list item
- Another bullet point
1. Numbered list item
2. Second numbered item
*Italic text*
**Bold text**
[Link text](https://example.com)
> Blockquote for notes or tips
- Install the requirements:
pip install -r requirements.txt
- Run the development server:
mkdocs serve
- Open your browser to
http://127.0.0.1:8000/
Use the included deploy script: python deploy.py