RecipeMD

A standard format for recipes as Markdown files and a python reference implementation. The reference implementation can be used as a CLI program and as a python library.

Quick Start

1. Install the tool: pip install recipemd (optionally you can also install shell completions)

2. Look at some example recipes or start with a recipe template to create your own recipes

3. Learn how to use the CLI tool with some example calls

Specification

We provide a specification for RecipeMD so other tools can use the format. The specification also comes with a set of test cases.

Contributing

You can take part in RecipeMD’s development in our GitHub repository.

Resources

You can use recipemd-extract to fetch and extract recipes from the web. We also maintain a list of recommended tools that work nicely with RecipeMD recipes.

Here are some RecipeMD repositories. You can also find a collection of recipes at web.recipemd.org.

• AberDerBart

• Chamaeleon-

• chrissi^

• core-dd

• crisartistry

• dadada

• dasnessie

• Evylon

• fscholdei

• haeckse

• Invisible4ever

• mist

• heinrob

• rixx

• tstehr

License

The specification and the reference implementation are licensed under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

Indices and tables

• Index

• Module Index

• Search Page