1
0
Fork 0
mirror of https://github.com/mealie-recipes/mealie.git synced 2025-08-02 20:15:24 +02:00

documentation

This commit is contained in:
Hayden 2020-12-24 19:32:49 -09:00
parent beed8576c2
commit e5304f0589
24 changed files with 119 additions and 132 deletions

View file

@ -1,7 +1,7 @@
# Meal Planner
## Working with Meal Plans
In Mealie you can create a mealplan based off the calendar inputs on the meal planner page. There is no limit to how long or how short a meal plan is. You may also create duplicate meal plans for the same date range. After selecting your date range, click on the card for each day and seach through recipes to find your choice. After selecting a recipe for all meals save the plan.
In Mealie you can create a mealplan based off the calendar inputs on the meal planner page. There is no limit to how long or how short a meal plan is. You may also create duplicate meal plans for the same date range. After selecting your date range, click on the card for each day and seach through recipes to find your choice. After selecting a recipe for all meals save the plan. You can also randomly generate meal plans.
To edit the meal in a meal plan simply select the edit button on the card in the timeline. Similiarly, to delete a mealplan click the delete button on the card in the timeline. Currently there is no support to change the date range in a meal plan.

View file

@ -1,10 +1,15 @@
# Admin Panel
# Site Settings Panel
!!! danger
As this is still a **BETA** It is reccomended that you backup your data often and store in more than one place. Adhear to backup best practies with the [3-2-1 Backup Rule](https://en.wikipedia.org/wiki/Backup)
### Theme Settings
![](img/admin-theme.png)
## Theme Settings
Color themes can be created and set from the UI in the settings page. You can select an existing color theme or create a new one. On creation of a new color theme random colors will first be generated, then you can select and save as you'd like. By default the "default" theme will be loaded for all new users visiting the site. All created color themes are avaiable to all users of the site. Seperate color themes can be set for both Light and Dark modes.
![](gifs/theme-demo.gif)
!!! note
Theme data is stored in cookies in the browser. Calling "Save Theme" will refresh the cookie with the selected theme as well save the theme to the database.
## Backup and Export
@ -17,10 +22,6 @@ To import a backup it must be in your backups folder. If it is in the backup fol
![](img/admin-backup.png)
## Meal Planner Webhooks
In the webhooks section you can find a list of all your endpoint URLs that are used as part of the meal planner
Meal planner webhooks are post requests sent from Mealie to an external endpoint. The body of the message is the Recipe JSON of the scheduled meal. If no meal is schedule, no request is sent. The webhook functionality can be enabled or disabled as well as scheduled. Note that you must "Save Webhooks" prior to any changes taking affect serverside.
![](img/admin-webhooks.png)
## SFTP Settings - Target Release 1.0
## User Settings - Target Release 1.0

View file

@ -0,0 +1,55 @@
# Development Road Map
Feature placement is not set in stone. This is much more of a guideline than anything else.
## v1.0 Roadmad
### Frontend
- [ ] Login / Logout Navigation
* [ ] Initial Page
* [ ] Logic / Function Calls
* [ ] Password Reset
### Backend
- [ ] User Setup
* [ ] Authentication
* [ ] Default Admin/Superuser Account
* [ ] Password Reset
* [ ] User Accounts
* [ ] Edit / Delete
## v0.2.0
### Front End
- [ ] Recipe Editor
* [ ] Basic Form Validation
- [ ] Recipe Viewer
* [ ] Print Page View - Like King Arthur Website
* [ ] Notes Hidden/Not Hidden
* [ ] Total Time Indicator
* [ ] Bake Time
### Backend
## v0.1.0 - Initial Release
## Frontend Tasks
- [ ] General
* [ ] Recipe Category Handling
- [x] Meal Plan
* [ ] Include Lunch / Dinner / Breaksfast Categories Option
### Backend Tasks
- [ ] Backup Options
* [ ] Force Update
* [ ] Rebuild
- [ ] Recipe Data
* [ ] Better Scraper
* [ ] Image Minification
* [ ] Scraper Data Validation
- [ ] Category Management
* [ ] Lunch / Dinner / Breakfast <- Meal Generation
* [ ] Dessert / Side / Appetizer / Bread / Drinks /

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.7 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Before After
Before After

View file

@ -6,8 +6,11 @@ theme:
features:
- navigation.instant
markdown_extensions:
- def_list
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- admonition
extra_css:
- stylesheets/custom.css