Contributing

Contributions are most welcome. If you would like to contribute, feel free to submit a pull request or open a new issue on the project over on Github.

Anyone can contribute a recipe. If you would like to contribute recipes, please read the information below.

Contributing recipes

If you have an awesome recipe and would like to share it with the world, you can do so by following the instructions below.

Recipes are stored at /src/recipes.

Submit a pull request with your recipe to the Github repository.

Alternatively, submit your recipe via mail to raphpb1912@gmail.com.

Feel free to include your own donation links in your submissions. Who knows, someone might really like the recipe.

Directory structure

  • /generator - The static site generator for the source files.
  • /src - The source files that the generator uses to build the files
  • /src/assets - Static assets like images and fonts
  • /src/components - Reusable HTML templates
  • /src/recipes - The recipes
  • /src/styles - Stylesheets

Notes

Generator

Output files are located at /dist

Recipes

Recipes are written in Markdown format, a simple and easy text format. You can learn more about markdown here.

When a new recipe is added, the catalog needs to be modified too. So, after creating a folder in the recipes directory with a rough but representative name of the recipe, create a file named "index.md". All the recipe content goes in that file. Assets go in the same folder too, so if you need to place any images for the recipe, just put them in the same folder as the recipe.

A recipe has to be submitted in the following format:

---
title: (The name of the recipe)
category: (The category or type of recipe)
preview: (The path to the image that is shown before the recipe)
dirname: (The name of the folder of the recipe that you are adding)
---

# ( The name of the recipe )

## Ingredients

( Your ingredients here )

## Directions

( The instructions for the recipe )