Skip to content

nicpottier/recipes

Repository files navigation

Recipes

A collection of recipes built with Hugo, a fast and modern static site generator.

About

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.).

Local Development

Prerequisites

  • Hugo (version 0.147.5 recommended)
  • Git

Setup

  1. Clone this repository:

    git clone https://github.com/nicpottier/recipes.git
    cd recipes
  2. Start the local development server:

    hugo server -D
  3. Visit http://localhost:1313 in your browser to view the site.

Docker Development Environment

If you prefer using Docker, we've included Docker configuration files to make setup easier.

Prerequisites

Setup with Docker

  1. Clone this repository:

    git clone https://github.com/nicpottier/recipes.git
    cd recipes
  2. Start the Docker container:

    docker-compose up
  3. Visit http://localhost:1313 in your browser to view the site.

This Docker setup uses Alpine Linux with Hugo ${HUGO_VERSION} installed, providing a lightweight and efficient development environment.

Adding a Recipe

Recipes are stored in the content/recipes/ directory as Markdown files.

Recipe Format

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 3

Development Tools

VS Code Integration

This 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.

Repository Structure

  • content/recipes/: Contains all the recipe Markdown files
  • themes/hyde-y/: The Hyde-Y theme files
  • config.toml: Main Hugo configuration file
  • static/: Static assets like images
  • layouts/: Custom layout templates (if any)

Building for Production

To build the site for production:

hugo

This will generate the static site in the public/ directory.

Contributing

  1. Fork the repository
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •