A collection of recipes built with Hugo, a fast and modern static site generator.
This is a simple recipe collection website that uses Hugo and the Hyde-Y theme to organize and display recipes. Recipes are organized by meals (breakfast, lunch, dinner) and cuisines (Italian, Korean, etc.).
-
Clone this repository:
git clone https://github.com/nicpottier/recipes.git cd recipes -
Start the local development server:
hugo server -D
-
Visit
http://localhost:1313in your browser to view the site.
If you prefer using Docker, we've included Docker configuration files to make setup easier.
-
Clone this repository:
git clone https://github.com/nicpottier/recipes.git cd recipes -
Start the Docker container:
docker-compose up
-
Visit
http://localhost:1313in your browser to view the site.
This Docker setup uses Alpine Linux with Hugo ${HUGO_VERSION} installed, providing a lightweight and efficient development environment.
Recipes are stored in the content/recipes/ directory as Markdown files.
Each recipe should have the following format:
+++
title = "Recipe Title"
date = "YYYY-MM-DD"
meals = ["breakfast", "lunch", "dinner"]
cuisines = ["italian", "american", "mexican"]
+++
Source: http://example.com/recipe-source
# Ingredients
* Ingredient 1
* Ingredient 2
* Ingredient 3
# Instructions
1. Step 1
2. Step 2
3. Step 3This repository includes VS Code settings and extension recommendations to enhance your development experience:
.vscode/settings.json: Provides consistent editor settings.vscode/extensions.json: Recommends useful extensions for working with Hugo and Markdown
When you open the project in VS Code, you'll be prompted to install the recommended extensions.
content/recipes/: Contains all the recipe Markdown filesthemes/hyde-y/: The Hyde-Y theme filesconfig.toml: Main Hugo configuration filestatic/: Static assets like imageslayouts/: Custom layout templates (if any)
To build the site for production:
hugoThis will generate the static site in the public/ directory.
- Fork the repository
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
This project is licensed under the MIT License.