Contributions
A guide on how to contribute to the project
Want to add your own favourite recipe? Awesome! This guide outlines the simple process for contributing to the recipe collection.
Maintaining Consistency
Following these steps ensures that any new recipes added are consistent with the current structure and can be merged smoothly.
Create Your MDX File
First, create a new file inside the content/docs directory. The easiest way to start is to copy and paste an existing recipe file (like proat.mdx) and use it as a template.
File Naming
Name your new file using the first letter of each word in the recipe's title. The format should be all lowercase.
File Naming Convention
Example: A recipe titled Veggie Scrambled Eggs on Toast would be named vseot.mdx. If the name is shorter like Protein Oatmeal, something like proat.mdx would be fine.
Update content/docs/meta.json
You must register your new page. Open the meta.json file add your new file's name (without the .mdx extension) to the "pages" array. This makes it appear in the sidebar navigation.
{
"pages": [
"---Recipes---"
"gypb",
"proat",
"vseot",
"your-new-filename-here"
]
}Open a Pull Request
Once you have created your file, filled out the template, and updated the meta.json file, commit your changes and open a Pull Request on GitHub.
Your submission will be reviewed, and once approved, your recipe will be live on the site!