Improve docs.

This commit is contained in:
Louis Cordier 2020-06-27 14:14:27 +02:00
parent a6e92f03f0
commit 1f81d1fed8

View file

@ -1,9 +1,23 @@
# Recipe Box # Recipe Box
This program takes a recipe URL and scrapes the recipe, converts it to Markdown format and store it in a Zettelkasten. ![Recipe Box](recipe_box.jpg)
I use the free [Obsidian](https://obsidian.md/) Zettelkasten software and repurpose it as a electronic recipe box.
This program takes a recipe URL, scrapes the recipe website, converts it to [Markdown](https://daringfireball.net/projects/markdown/syntax)
format and store it in your local [Zettelkasten](https://www.youtube.com/watch?v=XUltI4v_UU4).
I use the free [Obsidian](https://obsidian.md/) Zettelkasten software and re-purpose it as a electronic recipe box.
The user can edit the recipe, fix errors, make notes, rate it, add #tags and [[backlinks]] to organise his/her collection. The user can edit the recipe, fix errors, make notes, rate it, add #tags and [[backlinks]] to organise his/her collection.
A recipe box can be a [treasure chest](https://www.ourstate.com/a-kitchens-riches/), but you have to put in some effort. A recipe box can be a [treasure chest](https://www.ourstate.com/a-kitchens-riches/), but you have to put in some effort.
The idea is not to have the biggest collection of recipes, but to have the most valuable one. The one with the recipes you've
personally tested and most of your family love.
Since the recipes are stored in simple plaintext files it is easy to share with your friends and family, or pass down to the
next generation years from now.
> In our age when cloud services can shut down, get bought, or change privacy policy any day, the last thing you want is proprietary formats and data lock-in.
>
> With Obsidian, your data sits in a local folder. Never leave your life's work held hostage in the cloud again.
>
> Plain text Markdown also gives you the unparalleled interoperability to use any kind of sync, encryption, or data processing that works with plain text files.