@tmlmt/cooklang-parser 1.4.0 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,23 +15,9 @@ This library provides a set of tools to work with recipes written in the Cooklan
|
|
|
15
15
|
## Features
|
|
16
16
|
|
|
17
17
|
- **Cooklang Compliant:** Fully compliant with the Cooklang specifications.
|
|
18
|
-
- **Recipe Parsing:** Parse Cooklang recipes to extract metadata, ingredients, cookware, timers, and steps.
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
- `&`: referenced ingredient (quantities will be added)
|
|
22
|
-
- `-`: hidden ingredient
|
|
23
|
-
- `?`: optional ingredient
|
|
24
|
-
- All but `@` also work with Cookware
|
|
25
|
-
- **Range values:**
|
|
26
|
-
- `@eggs{2-4}` will show eggs as an ingredient with a quantity range of 2 to 4
|
|
27
|
-
- `@water{1%L} and @&water{1/4-1/2%L}` will show water as an ingredient with a quantity range of 1.25 to 1.5 L
|
|
28
|
-
- Also works with Cookware and Timers
|
|
29
|
-
- **Cookware quantities:**
|
|
30
|
-
- Cookware can also be quantified (without any unit, e.g. `#bowls{2}`)
|
|
31
|
-
- Quantities will be added if cookware are referenced, e.g. `#&bowls{2}`
|
|
32
|
-
- **Ingredient aliases:**
|
|
33
|
-
- `@ingredientName|displayAlias{}` will add the ingredient as "ingredientName" in the ingredients list, but will display is as "displayAlias" in the preparation step.
|
|
34
|
-
- Also work with referencing etc., e.g. `Mix @wheat flour{100%g} with additional @&wheat flour|flour{50%g}` enables to get 150g of wheat flour in the ingredients list, and let you display "Mix wheat flour (100 g) with additional flour (50 g)" in your recipe renderer.
|
|
18
|
+
- **Recipe Parsing:** Parse Cooklang recipes to extract metadata, ingredients, cookware, timers, and steps.
|
|
19
|
+
Several extensions on top of the original cooklang specifications
|
|
20
|
+
and [detailed in the docs](https://cooklang-parser.tmlmt.com/guide-extensions).
|
|
35
21
|
- **Recipe Scaling:** Scale recipes by a given factor.
|
|
36
22
|
- **Shopping Lists:** Generate shopping lists from one or more recipes.
|
|
37
23
|
- **Category Configuration:** Categorize shopping list ingredients based on a custom category configuration.
|