You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Correct grammar and typo
* Correct grammar
* Fix some words
* Correct formatting
* Correct grammar on v1 migration page
* Correct grammar, punctuation, and typos in faq
* Fix grammar in installation-checklist
* One last correction
Copy file name to clipboardExpand all lines: docs/docs/documentation/getting-started/faq.md
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## How do I enable "smart" ingredient handling?
4
4
5
-
You might have noticed that scaling up a recipe or making a shopping list doesn't by default handle the ingredients in a way you might expect. Depending on your settings, scaling up might yield things like `2 1 cup broth` instead of `2 cup broth`. And making shopping lists from reciepes that have shared ingredients can yield multiple lines of the same ingredient. **But** mealie has a mechanism to intelligently handle ingredients and make your day better. How?
5
+
You might have noticed that scaling up a recipe or making a shopping list doesn't by default handle the ingredients in a way you might expect. Depending on your settings, scaling up might yield things like `2 1 cup broth` instead of `2 cup broth`. And making shopping lists from reciepes that have shared ingredients can yield multiple lines of the same ingredient. **But**, mealie has a mechanism to intelligently handle ingredients and make your day better. How?
6
6
### Set up your Foods and Units
7
7
Do the following just **once**. Doing this applies to your whole group, so be careful.
8
8
@@ -26,9 +26,9 @@ Do the following for each recipe you want to intelligently handle ingredients.
26
26
6. Click the Edit button/icon again
27
27
7. Scroll to the ingredients and you should see new fields for Amount, Unit, Food, and Note. The Note in particular will contain the original text of the Recipe.
28
28
8. Click `Parse` and you will be taken to the ingredient parsing page.
29
-
9. Choose your parser. the`Natural Language Parser` works very well, but you can also use the `Brute Parser`.
30
-
10. Click `Parse All` and your ingredients should be separated out into Units and Foods based on your seeding in Step 1 above.
31
-
11. For ingredients where the Unit or Food were not found, you can click a button to accept an automatically suggested Food to add to the database. Or manually enter the Unit/Food and hit `Enter` (or click `Create`) to add it to the database
29
+
9. Choose your parser. The`Natural Language Parser` works very well, but you can also use the `Brute Parser`.
30
+
10. Click `Parse All`, and your ingredients should be separated out into Units and Foods based on your seeding in Step 1 above.
31
+
11. For ingredients where the Unit or Food was not found, you can click a button to accept an automatically suggested Food to add to the database. Or, manually enter the Unit/Food and hit `Enter` (or click `Create`) to add it to the database
32
32
12. When done, click `Save All` and you will be taken back to the recipe. Now the Unit and Food fields of the recipe should be filled out.
33
33
34
34
Scaling up this recipe or adding it to a Shopping List will now smartly take care of ingredient amounts and duplicate combinations.
@@ -64,7 +64,7 @@ No. Due to limitations from the Javascript Framework, mealie doesn't support ser
64
64
65
65
## Can I install Mealie without docker?
66
66
67
-
Yes, you can install Mealie on your local machine. HOWEVER, it is recommended that you don't. Managing non-system versions of python, node, and npm is a pain. Moreover updating and upgrading your system with this configuration is unsupported and will likely require manual interventions. If you insist on installing Mealie on your local machine, you can use the links below to help guide your path.
67
+
Yes, you can install Mealie on your local machine. HOWEVER, it is recommended that you don't. Managing non-system versions of python, node, and npm is a pain. Moreover, updating and upgrading your system with this configuration is unsupported and will likely require manual interventions. If you insist on installing Mealie on your local machine, you can use the links below to help guide your path.
@@ -75,25 +75,25 @@ Mealie can use fuzzy search, which is robust to minor typos. For example, search
75
75
2. Set up a [Postgres](./installation/postgres.md) instance of Mealie
76
76
3. Upload the backup .zip and click to apply it (as as migration)
77
77
78
-
## How i can attach an image or video to a Recipe?
78
+
## How can I attach an image or video to a Recipe?
79
79
80
-
Yes. Mealie's Recipe Steps and other fields support the markdown syntax and therefor supports images and videos. To attach an image to the recipe, you can upload it as an asset and use the provided copy button to generate the html image tag required to render the image. For videos, Mealie provides no way to host videos. You'll need to host your videos with another provider and embed them in your recipe. Generally, the video provider will provide a link to the video and the html tag required to render the video. For example, youtube provides the following link that works inside a step. You can adjust the width and height attributes as necessary to ensure a fit.
80
+
Mealie's Recipe Steps and other fields support markdown syntax and therefore support images and videos. To attach an image to the recipe, you can upload it as an asset and use the provided copy button to generate the html image tag required to render the image. For videos, Mealie provides no way to host videos. You'll need to host your videos with another provider and embed them in your recipe. Generally, the video provider will provide a link to the video and the html tag required to render the video. For example, YouTube provides the following link that works inside a step. You can adjust the width and height attributes as necessary to ensure a fit.
81
81
82
82
```html
83
83
<iframewidth="560"height="315"src="https://www.youtube.com/embed/nAUwKeO93bY"title="YouTube video player"frameborder="0"allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"allowfullscreen></iframe>
84
84
```
85
85
86
86
## How can I unlock my account?
87
87
88
-
If your account has been locked by bad password attempts, you can use an administrator account to unlock another account. Alternatively you can unlock all account via a scripts within the container.
88
+
If your account has been locked by bad password attempts, you can use an administrator account to unlock another account. Alternatively, you can unlock all accounts via a script within the container.
89
89
90
90
```shell
91
91
docker exec -it mealie-next bash
92
92
93
93
python /app/mealie/scripts/reset_locked_users.py
94
94
```
95
95
96
-
## How can I change my password
96
+
## How can I change my password?
97
97
98
98
You can change your password by going to the user profile page and clicking the "Change Password" button. Alternatively you can use the following script to change your password via the CLI if you are locked out of your account.
Managing private groups and recipes can be confusing. The following diagram and notes should help explain how they work to determine if a recipe can be shared publicly.
109
109
110
-
- Private links that are generated using th`Share` button bypass all group and recipe permissions.
111
-
- Private groups block all access to recipes, including those that are public. Expect as noted above.
110
+
- Private links that are generated using the `Share` button bypass all group and recipe permissions.
111
+
- Private groups block all access to recipes, including those that are public, except as noted above.
112
112
- Private recipes block all access to the recipe from public links. This does not affect Private Links.
113
113
114
114
```mermaid
@@ -133,7 +133,7 @@ stateDiagram-v2
133
133
```
134
134
135
135
## Can I use fail2ban with mealie?
136
-
Yes, mealie is configured to properly forward external IP addresses into the `mealie.log` logfile. Note that, due to restrictions in docker, IP address forwarding only works on linux.
136
+
Yes, mealie is configured to properly forward external IP addresses into the `mealie.log` logfile. Note that due to restrictions in docker, IP address forwarding only works on Linux.
137
137
138
138
Your fail2ban usage should look like the following:
139
139
```
@@ -142,12 +142,12 @@ Use failregex line : ^ERROR:\s+Incorrect username or password from <HOST>
142
142
```
143
143
144
144
## Why An API?
145
-
An API allows integration into applications like [Home Assistant](https://www.home-assistant.io/) that can act as notification engines to provide custom notifications based of Meal Plan data to remind you to defrost the chicken, marinade the steak, or start the CrockPot. Additionally, you can access nearly any backend service via the API giving you total control to extend the application. To explore the API spin up your server and navigate to http://yourserver.com/docs for interactive API documentation.
145
+
An API allows integration into applications like [Home Assistant](https://www.home-assistant.io/) that can act as notification engines to provide custom notifications based on Meal Plan data to remind you to defrost the chicken, marinade the steak, or start the CrockPot. Additionally, you can access nearly any backend service via the API giving you total control to extend the application. To explore the API spin up your server and navigate to http://yourserver.com/docs for interactive API documentation.
146
146
147
147
## Why a Database?
148
-
Some users of static-site generator applications like ChowDown have expressed concerns about their data being stuck in a database. Considering this is a new project it is a valid concern to be worried about your data. Mealie specifically addresses this concern by provided automatic daily backups that export your data in json, plain-text markdown files, and/or custom Jinja2 templates. **This puts you in controls of how your data is represented** when exported from Mealie, which means you can easily migrate to any other service provided Mealie doesn't work for you.
148
+
Some users of static-site generator applications like ChowDown have expressed concerns about their data being stuck in a database. Considering this is a new project, it is a valid concern to be worried about your data. Mealie specifically addresses this concern by provided automatic daily backups that export your data in json, plain-text markdown files, and/or custom Jinja2 templates. **This puts you in control of how your data is represented** when exported from Mealie, which means you can easily migrate to any other service provided Mealie doesn't work for you.
149
149
150
150
As to why we need a database?
151
151
152
-
-**Developer Experience:** Without a database a lot of the work to maintain your data is taken on by the developer instead of a battletested platform for storing data.
153
-
-**Multi User Support:** With a solid database as backend storage for your data Mealie can better support multi-user sites and avoid read/write access errors when multiple actions are taken at the same time.
152
+
-**Developer Experience:** Without a database, a lot of the work to maintain your data is taken on by the developer instead of a battle-tested platform for storing data.
153
+
-**Multi User Support:** With a solid database as backend storage for your data, Mealie can better support multi-user sites and avoid read/write access errors when multiple actions are taken at the same time.
Copy file name to clipboardExpand all lines: docs/docs/documentation/getting-started/features.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -38,15 +38,15 @@ Categories are the overarching organizer for recipes. You can assign as many cat
38
38
39
39
#### Tags
40
40
41
-
Tags, are nearly identical to categories in function but play a secondary role in some cases. As such, we recommend that you use tags freely to help you organize your recipes by more specific topics. For example, if a recipe can be frozen or is a great left-over meal, you could assign the tags **frozen** and **left-over** and easily filter for those at a later time.
41
+
Tags are nearly identical to categories in function but play a secondary role in some cases. As such, we recommend that you use tags freely to help you organize your recipes by more specific topics. For example, if a recipe can be frozen or is a great left-over meal, you could assign the tags **frozen** and **left-over** and easily filter for those at a later time.
Tools, are another way that some users like to organize their recipes. If a recipe requires some specific equipment if can be helpful to assign the tools to the recipes. This is particularly useful for things that are less common, like a pressure cooker, or a sous vide.
47
+
Tools are another way that some users like to organize their recipes. If a recipe requires some specific equipment, it can be helpful to assign tools to the recipes. This is particularly useful for things that are less common, like a pressure cooker or a sous vide.
48
48
49
-
Each of the above organizers can be filtered in searches, and have their own pages where you can view all the recipes that are associated with those organizers.
49
+
Each of the above organizers can be filtered in searches and have their own pages where you can view all the recipes that are associated with those organizers.
@@ -64,7 +64,7 @@ Mealie also has the concept of cookbooks. These can be created inside of a group
64
64
65
65
## Meal Planning
66
66
67
-
Mealie uses a calendar like view to help you plan your meals. It shows you the previous day, and the next 6 days by default. You can toggle through the calendar by clicking the arrows on the top of the page. In editor mode, you can use the random recipe buttons, or manually add an entry.
67
+
Mealie uses a calendar like view to help you plan your meals. It shows you the previous day and the next 6 days by default. You can toggle through the calendar by clicking the arrows on the top of the page. In editor mode, you can use the random recipe buttons or manually add an entry.
68
68
69
69
!!! tip
70
70
You can also add a "Note" type entry to your meal-plan when you want to include something that might not have a specific recipes. This is great for leftovers, or for ordering out.
@@ -73,24 +73,24 @@ Mealie uses a calendar like view to help you plan your meals. It shows you the p
73
73
74
74
### Planner Rules
75
75
76
-
The meal planner has the concept of plan rules. These offer a flexible way to use your organizers to customize how a random recipe is inserted into your meal plan. You can set rules to restrict the pool of recipes based on the Tags and/or Categories of a recipe. Additionally, since meal plans have a Breakfast, Lunch, Dinner, and Snack labels you can specifically set a rule to be active for a **specific meal type** or even a **specific day of the week.**
76
+
The meal planner has the concept of plan rules. These offer a flexible way to use your organizers to customize how a random recipe is inserted into your meal plan. You can set rules to restrict the pool of recipes based on the Tags and/or Categories of a recipe. Additionally, since meal plans have a Breakfast, Lunch, Dinner, and Snack labels, you can specifically set a rule to be active for a **specific meal type** or even a **specific day of the week.**
The shopping lists feature is a great way to keep track of what you need to buy for your next meal. You can add items directly to the shopping list, or link a recipe and all of it's ingredients to track meals during the week.
82
+
The shopping lists feature is a great way to keep track of what you need to buy for your next meal. You can add items directly to the shopping list or link a recipe and all of it's ingredients to track meals during the week.
83
83
84
84
!!! warning
85
-
At this time there isn't a tight integration between meal-plans and shopping lists, however it's something we have planned for the future.
85
+
At this time there isn't a tight integration between meal-plans and shopping lists; however, it's something we have planned for the future.
86
86
87
87
88
88
[Shopping List Demo](https://demo.mealie.io/shopping-lists){ .md-button .md-button--primary }
89
89
90
90
91
91
## Data Management
92
92
93
-
Managing a robust collection of recipes inevitable requires a lot of data. Mealie has a robust data management system that allows you to easily some of the more important data sets in your collection. Here's some of the features that are available in the `group/data/<type>` pages:
93
+
Managing a robust collection of recipes inevitable requires a lot of data. Mealie has a robust data management system that allows you to easily export some of the more important data sets in your collection. Here's some of the features that are available in the `group/data/<type>` pages:
94
94
95
95
- Recipes
96
96
- Bulk Actions
@@ -113,7 +113,7 @@ Managing a robust collection of recipes inevitable requires a lot of data. Meali
113
113
114
114
### Site Settings
115
115
116
-
The site settings page contains general information about your installation like the application version, some configuration details, and some utilities to help you confirm your installation is working as expected. For example, you can use the Email Configuration section to validate that your email credentials are setup correctly and that the email service is working as expected. Additionally, there is a docker-volume utility that will confirm your volumes are configured and shared correctly between the front and backend of the application.
116
+
The site settings page contains general information about your installation like the application version, some configuration details, and some utilities to help you confirm your installation is working as expected. For example, you can use the Email Configuration section to validate that your email credentials are set up correctly and that the email service is working as expected. Additionally, there is a docker-volume utility that will confirm your volumes are configured and shared correctly between the front and backend of the application.
@@ -125,7 +125,7 @@ There is a small management area for users and groups that allows you to create,
125
125
126
126
### Backups
127
127
128
-
The backups page provides a full system backup of your installation including all assets and images related to recipes. These are archived into a zip file and stored on the server but can also be downloaded through the UI. Due to some issues in the past Mealie no longer performs automatic backups,**it is advised that during setup you also setup a backup strategy to ensure your data is not lost.**
128
+
The backups page provides a full system backup of your installation including all assets and images related to recipes. These are archived into a zip file and stored on the server but can also be downloaded through the UI. Due to some issues in the past, Mealie no longer performs automatic backups;**it is advised that during setup you also set up a backup strategy to ensure your data is not lost.**
0 commit comments