Homebrew: Recipe

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.1.0

🍺recipe

A recipe is a set of instructions that describes how to prepare or make something, especially a dish of prepared food or drink.

An Example:

The _Meta is normally included in a full JSON, for this example it has been removed. See the link for how to develop the _meta.

		{
			"name": "Example Recipe",
			"source": "Cooking",
			"fluff": {
				"entries": [
					""
				],
				"images": [
					{
						"type": "image",
						"href": {
							"type": "internal",
							"path": "recipes/Bread.jpg"
						}
					}
				]
			},
			"serves": {
                               "note:" "brief comment"
				"min": ,
 				"max": 
			},
			"ingredients": [
                               {
                                       "type": "ingredient",
                                       "entry": "{=amount1/v} pound thick-cut bacon",
                                       "amount1": 1
                               },
                               {
                                       "type": "ingredient",
                                       "entry": "{=amount1/v} tablespoons light brown sugar",
                                       "amount1": 3
                               },
			],
			"instructions": [
				"Get ready to cook!", // As above, if there are no sub-headings, list the steps at this level
				{
					"type": "entries",
					"name": "",
					"entries": [
						""
					]
				},
				{
					"type": "entries",
					"name": "",
					"entries": [
						""
					]
				}
			],
                       "allergenGroups": [
                               "celery",
                               "milk"
                       ],
			"noteCook": [
				""
			]
		},
Learn More
In the example; <description_of_results/fields>

Field List (Sources)

If you do not include the required fields (denoted with bold text) the JSON may pass JSONLint but will fail upon stitch.

Field Name Data Type Description Required
name String Recipe's name/title Yes
source String descript Yes
fluff Array of Objects descript no
fluff.entries Entries Object descript no
fluff.images Image Object an image of the dish no
serves Object (Array of Integers) How many servings no
ingredients Array of objects the component parts and quantity of them yes
instructions Entries Steps needed to create or craft such yes
allergenGroups Array of Strings List here no
noteCook Entries descript no



πŸ—„οΈ Reference Files:
[[ |πŸ›’οΈ Requirements Specs (Schemata) ]]
[[ |🧾 Blank Template]]
[[ |πŸ“– Sample JSON]]
[[ |πŸ’Ύ Functional Example]]
[[ |πŸ“š Repository of Other Examples]]


Reference Tag: (how to link to entries within the "entries":)


Example:



Homebrew Support


Known Issues
Looks like its perfect... (Did we miss anything?)


NAME OF THE ISSUE
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Work Around  : Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.


FAQ
Nothing's here (Do you have any suggestions?)
Best Practices
None as yet (Do you have any suggestions?)



Related Features



Did that answer your question(s)?

If not please check the under Support; Troubleshooting or the Known Issues page for further guidance, or go to the Discord community and leave a comment in the issues channel.

If you enjoy the project, please follow this link to see how you can contribute and help make it even better.

Do you have time to take a Survey?