How to Write a Good Recipe
Tips on contributing to the project
This site is built in GitBook. Start by reading their documentation on how to
Sections
To make recipes easier to read, it is helpful if they follow a similar format.
Introduction
Outlines the problem the recipe is trying to fix or the goal of the technique being addressed.
Ingredients
What do you need to know or have set up in order to follow the recipe. An application installed, a plugin activated, familiarity with a certain programming language, etc.
Hints, callouts and or warnings can be highlighted here as necessary
How to do it
Step by step instructions required to follow the recipe
How it works
A detailed explanation of what happened in the previous section, so we are not perpetuating technology "black boxes" but helping people understand how to take control.
Further Resources
This section can be used to give additional information to make the reader more knowledgeable about specific aspects of the recipe, or provide helpful links to other useful information.
To make getting started easier, we have provided a Recipe Template you can duplicate and edit
Last updated