mirror of
https://github.com/mealie-recipes/mealie.git
synced 2025-08-04 04:55:21 +02:00
Docs/v0.5.0 second pass (#496)
* update docs * use auto-gen routes * dumb deps * remove whitespace * github action to build dev docs container * no cache Co-authored-by: hay-kot <hay-kot@pm.me>
This commit is contained in:
Hayden
GitHub
parent
06ed377c00
commit
e34079673c
42 changed files with 555 additions and 508 deletions
|
|
@ -2,14 +2,14 @@
|
|||
Your sites settings panel can only be accessed by administrators. This where you can customize your site for all users.
|
||||
|
||||
## Home Page Settings
|
||||
| Option | Description |
|
||||
| ------------------ | -------------------------------------------------------------- |
|
||||
| Show Recent | To display the recent recipes section on the home page |
|
||||
| Card Per Section | The amount of cards displayed in each section on the home page |
|
||||
| Home Page Sections | Category sections to include on the home page |
|
||||
| Language | The default site language |
|
||||
| First day of the week | The default start day of the week used in Meal Plans |
|
||||
| Custom Pages | Create a [custom page](../admin/building-pages.md) which appears in the sidebar with the categories you chose |
|
||||
| Option | Description |
|
||||
| --------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| Show Recent | To display the recent recipes section on the home page |
|
||||
| Card Per Section | The amount of cards displayed in each section on the home page |
|
||||
| Home Page Sections | Category sections to include on the home page |
|
||||
| Language | The default site language |
|
||||
| First day of the week | The default start day of the week used in Meal Plans |
|
||||
| Custom Pages | Create a [custom page](../admin/building-pages.md) which appears in the sidebar with the categories you chose |
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,29 +2,8 @@
|
|||
|
||||
## Getting a Token
|
||||
|
||||
Mealie supports long-live api tokens in the user frontend. In you profile section you can use the
|
||||
Mealie supports long-live api tokens in the user frontend. See [user settings page](../../users-groups/user-settings/)
|
||||
|
||||
### Curl
|
||||
```bash
|
||||
curl -X 'POST' \
|
||||
'https://mealie-demo.hay-kot.dev/api/auth/token' \
|
||||
-H 'accept: application/json' \
|
||||
-H 'Content-Type: application/x-www-form-urlencoded' \
|
||||
-d 'grant_type=&username=changeme%40email.com&password=demo&scope=&client_id=&client_secret='
|
||||
|
||||
```
|
||||
|
||||
#### Response
|
||||
```json
|
||||
{
|
||||
"snackbar": {
|
||||
"text": "User Successfully Logged In",
|
||||
"type": "success"
|
||||
},
|
||||
"access_token": "your-long-token-string",
|
||||
"token_type": "bearer"
|
||||
}
|
||||
```
|
||||
|
||||
## Key Components
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,11 @@
|
|||
# Recipes
|
||||
|
||||
## URL Import
|
||||
Adding a recipe can be as easy as clicking in the bottom-right corner, copying the recipe URL into Mealie and letting the web scrapper organize information. Currently this scraper is implemented with [scrape-schema-recipe package](https://pypi.org/project/scrape-schema-recipe/). You may have mixed results on some websites, especially with blogs or non-specific recipe websites. See the bulk import Option below for another a convenient way to add blog style recipes into Mealie.
|
||||
You can add different sections to make sure your recipe is divided correctly into separate 'chapters'
|
||||
Adding a recipe can be as easy as clicking in the bottom-right corner, copying the recipe URL into Mealie and letting the web scrapper organize information. Currently this scraper is implemented with [recipe-scrapers](https://github.com/hhursev/recipe-scrapers). You may have mixed results on some websites, especially with blogs or non-specific recipe websites. See the bulk import Option below for another a convenient way to add blog style recipes into Mealie.
|
||||
|
||||
!!! tip
|
||||
You can find a list of some of the supported sites in the recipe-scrapers repo. If you're site isn't supported, you can work with the recipe-scrapers team to implement it and we can down-stream those changes into Mealie.
|
||||
|
||||
|
||||
|
||||
## Using Bookmarklets
|
||||
|
|
@ -19,12 +22,33 @@ window.open(dest, '_blank')
|
|||
```
|
||||
|
||||
## Recipe Editor
|
||||
|
||||
{: align=right style="height:225px;width:275px"}
|
||||
Recipes can be edited and created via the UI. This is done with both a form based approach where you have a UI to work with as well as with a in browser JSON Editor. The JSON editor allows you to easily copy and paste data from other sources.
|
||||
|
||||
|
||||
You can also add a custom recipe with the UI editor built into the web view.
|
||||
You can also add a custom recipe with the UI editor built into the web view. Using the `+` button on the site.
|
||||
|
||||
### Recipe Settings
|
||||
|
||||
Settings for a specific recipe can be adjusted in the settings menu inside the editor. Currently the settings supports
|
||||
|
||||
- Settings a Recipe to Public/Private
|
||||
- Show Nutrition Values
|
||||
- Show Assets
|
||||
- Landscape Mode (Coming Soon)
|
||||
|
||||
!!! note
|
||||
Recipes set to private will only be displayed when a user is logged in. Currently there is no way to generate a share-link for a private recipe, but it is on the roadmap.
|
||||
|
||||
### Recipe Assets
|
||||
|
||||
While in the editor you also have an opportunity to upload any asset to your recipe. There are several icons that you can choose from or you can choose an arbitrary file icon. Once uploaded you can view or download the asset when viewing the page.
|
||||
|
||||
!!! tip
|
||||
You can get a link to an asset to embed in a recipe step by select the copy icon in editor mode.
|
||||
|
||||
### Bulk Import
|
||||
|
||||
## Bulk Import
|
||||
Mealie also supports bulk import of recipe instructions and ingredients. Select "Bulk Add" in the editor and paste in your plain text data to be parsed. Each line is treated as one entry and will be appended to the existing ingredients or instructions if they exist. Empty lines will be stripped from the text.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,21 +1,6 @@
|
|||
#Toolbox
|
||||
The toolbox gives you multiple options to clean-up and organize your recipes. You can get notified through different channels.
|
||||
You can access it through the 'Settings' menu or through the [dashboard](../admin/dashboard.md).
|
||||
# External Notifications
|
||||
|
||||
|
||||
## Category and Tag Editor
|
||||
The 'Categories' and 'Tags' tab give you the option to bulk assign categories and tags to multiple recipes. You could also remove the unused ones or title case them all.
|
||||
|
||||
|
||||
|
||||
## Bulk Organize
|
||||
The 'Organize' tab can be used to show all of the items that do not have any category or tag assigned.
|
||||
|
||||
|
||||
|
||||
## External Notifications
|
||||
|
||||
### Apprise
|
||||
## Apprise
|
||||
|
||||
Using the [Apprise](https://github.com/caronc/apprise/) library Mealie is able to provided notification services for nearly every popular service. Some of our favorites are...
|
||||
|
||||
|
|
@ -28,7 +13,7 @@ Using the [Apprise](https://github.com/caronc/apprise/) library Mealie is able t
|
|||
But there are some many to choose from! Take a look at their wiki for information on how to create their URL formats and that you can use to create a notification integration in Mealie.
|
||||
|
||||
|
||||
### Subscribe Events
|
||||
## Subscribe Events
|
||||
There are several categories of events that mealie logs that can be broadcast with the notifications feature. You can also see a feed of your events in the Admin Dashboard
|
||||
|
||||
- General Events
|
||||
|
|
@ -52,15 +37,15 @@ There are several categories of events that mealie logs that can be broadcast wi
|
|||
In most cases the events will also provide details on which user performed the action. Now you'll know when your grandma deletes your favorite recipe!
|
||||
|
||||
!!! info
|
||||
This is a new feature and we are still working through all the possibilities of events. if you have an idea for an event let us know!
|
||||
This is a new feature and we are still working through all the possibilities of events. if you have an idea for an event let us know!
|
||||
|
||||
|
||||
### Creating a New Notification
|
||||
## Creating a New Notification
|
||||
|
||||
New events can be created and viewed in admin Toolbox `/admin/toolbox?tab=event-notifications`. Select the "+ Notification" button and you'll be provided with a dialog. Complete the form using the URL for the service you'd like to connect to. Before saving be sure to use the test feature.
|
||||
|
||||
!!! tip
|
||||
The feedback provided from the test feature is only an indicated of if the URL you provided is valid, not if the message was successfully sent. Be sure to check the notification feed for the test message.
|
||||
The feedback provided from the test feature is only an indicated of if the URL you provided is valid, not if the message was successfully sent. Be sure to check the notification feed for the test message.
|
||||
|
||||
|
||||
|
||||
17
docs/docs/documentation/toolbox/organize-tools.md
Normal file
17
docs/docs/documentation/toolbox/organize-tools.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
#Toolbox
|
||||
The toolbox gives you multiple options to clean-up and organize your recipes. You can get notified through different channels.
|
||||
You can access it through the 'Settings' menu or through the [dashboard](../admin/dashboard.md).
|
||||
|
||||
|
||||
## Category and Tag Editor
|
||||
|
||||
The 'Categories' and 'Tags' tab give you the option to bulk assign categories and tags to multiple recipes. You could also remove the unused ones or title case them all.
|
||||
|
||||
|
||||
|
||||
## Bulk Organize
|
||||
|
||||
The 'Organize' tab can be used to show all of the items that do not have any category or tag assigned.
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,8 +1,9 @@
|
|||
# Meal Planner
|
||||
|
||||
## Working with Planner
|
||||
In Mealie you can create a meal plan 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 search through recipes to find your choice. Add a side-dish if you prefer to. After selecting a recipe for all meals, save the plan.
|
||||
|
||||
In Mealie you can create a meal plan 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 search through recipes to find your choice. Add a side-dish if you prefer to. After selecting a recipe for all meals, save the plan. Selecting the 'No Recipe' button will allow you to add an entry without a recipe by providing a title and description
|
||||
|
||||
You can also randomly generate meal plans with the dice-button at the bottom.
|
||||
|
||||
To edit the meal in a meal plan simply select the edit button on the card in the timeline. Similarly, to delete a meal plan click the delete button on the card in the timeline. Currently, there is no support to change the date range in a meal plan.
|
||||
|
|
|
|||
|
|
@ -1,15 +1,14 @@
|
|||
# User Settings
|
||||
|
||||
A user will be able to access 3 sections in their admin panel. The user profile, themes, group/meal-plan settings section.
|
||||
|
||||
## Profile Settings
|
||||
In as users profile they are able to
|
||||
In the users profile they are able to:
|
||||
|
||||
- Change Display Name
|
||||
- Change Email
|
||||
- Update Password
|
||||
- View Their Group
|
||||
- Upgrade Profile Picture (Experimental)
|
||||
- Update Profile Picture (Experimental)
|
||||
- Create API Keys
|
||||
|
||||
## Themes
|
||||
Color themes can be created and set from the UI in the Settings-Profile page. You can select an existing color theme or create a new one. On creation of a new color theme, the default colors will be used, 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 available to all users of the site. Theme Colors will be set for both light and dark modes.
|
||||
|
|
@ -23,3 +22,12 @@ Color themes can be created and set from the UI in the Settings-Profile page. Yo
|
|||
In the meal planner section a user can select categories to be used as a part of the random recipe selector in the meal plan creator. If no categories are selected, all recipes will be used
|
||||
|
||||
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" prior to any changes taking affect server side.
|
||||
|
||||
## API Key Generation
|
||||
Users can quickly and easily generate API keys with the user interface. Provide a name for your token and then you are shown 1 time the generated API key. If you ever loose the API key you are not able to identify or retrieve it from the UI.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! warning
|
||||
API keys are stored in plain text in the database.
|
||||
Loading…
Add table
Add a link
Reference in a new issue