docs/update outline (#471)
* docs update * reorganize * plausible analytics Co-authored-by: hay-kot <hay-kot@pm.me>
This commit is contained in:
Hayden
GitHub
parent
95b6ab86d0
commit
a75de6d1cf
29 changed files with 104 additions and 78 deletions
0
docs/docs/assets/js/analytics.js
Normal file
0
docs/docs/assets/js/analytics.js
Normal file
|
|
@ -19,7 +19,7 @@ To import a backup it must be in your backups folder. If it is in the backup fol
|
|||
|
||||
## Demo
|
||||
|
||||
|
||||
|
||||
|
||||
## API Examples
|
||||
You can use the API to create and retrieve backups remotely from any server that can access the Mealie instance. This is useful for easily managing off-site backups via cron-job or other scheduled tasks. You can find interactive documentation for your API at https://your-mealie-instance.com/docs
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
The dashboard gives you a quick overview of how your Mealie is doing. There is a 'Recipes' card, an overview of the users and groups, an 'Events' card and a 'Backups' card.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
##Recipes
|
||||
|
|
@ -11,7 +11,7 @@ Your sites settings panel can only be accessed by administrators. This where you
|
|||
| First day of the week | The default start day of the week used in Meal Plans |
|
||||
| Custom Pages | Create a custom page which appears in the sidebar with the categories you chose |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ There are two ways to create users in Mealie.
|
|||
### Manually Creating a User
|
||||
In the Manage Users section you are able to create a user by providing the necessary information in the pop-up dialog.
|
||||
|
||||
{: align=right style="height:50%;width:50%"}
|
||||
{: align=right style="height:50%;width:50%"}
|
||||
|
||||
- User Name
|
||||
- Email
|
||||
|
|
@ -69,7 +69,7 @@ When creating users manually, their password will be set from the default assign
|
|||
### Sign Up Links
|
||||
You can generate sign-up links in the Manage Users section. Select the "create link" button and provide the name of the link and if the user will be an administrator. Once a link is created it will populate in the table where you'll be able to see all active links, delete a link, and copy the link as needed.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! tip
|
||||
When a link is used it is automatically removed from the database.
|
||||
|
|
@ -77,7 +77,7 @@ You can generate sign-up links in the Manage Users section. Select the "create l
|
|||
## Creating Groups
|
||||
You can easily create and manage groups via the frontend in the admin panel under "Manage Users". Navigate to the groups tab and you'll find a "create group" button as well as a list of all groups in your database. To create a group, select the "create group" button and provide a name for the new group. Once created you can now assign users to the new group.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! tip
|
||||
User Groups can only be deleted if no users are apart of the group. If you want to delete a group, you must assign the users to another group before removing.
|
||||
|
|
@ -9,7 +9,7 @@ Starting in v0.4.1 you are now able to use the uri `/api/meal-plans/today
|
|||
|
||||
Here's an example where `sensor.mealie_todays_meal` is pulling in the meal-plan name and I'm using the url to get the image.
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
type: picture-entity
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed!
|
||||
|
||||
|
||||
{: align=right style="height:400px;width:400px"}
|
||||
{: align=right style="height:400px;width:400px"}
|
||||
|
||||
|
||||
User [brasilikum](https://github.com/brasilikum) opened an issue on the main repo about how they had created an [iOS shortcut](https://github.com/hay-kot/mealie/issues/103) for interested users. This is a useful utility for iOS users who browse for recipes in their web browser from their devices.
|
||||
|
|
@ -18,7 +18,7 @@ Don't know what an iOS shortcut is? Neither did I! Experienced iOS users may alr
|
|||
Basically it is a visual scripting language that lets a user build an automation in a guided fashion. The automation can be [shared with anyone](https://www.icloud.com/shortcuts/6ae356d5fc644cfa8983a3c90f242fbb) but if it is a user creation, you'll have to jump through a few hoops to make an untrusted automation work on your device. In brasilikum's shortcut, you need to make changes for it to work. Recent updates to the project have changed some of the syntax and folder structure since its original creation.
|
||||
|
||||
|
||||
{: align=right style="height:500;width:400px"}
|
||||
{: align=right style="height:500;width:400px"}
|
||||
|
||||
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Getting a Token
|
||||
|
||||
Currently Mealie doesn't support creating a long-live token. You can however get a token from the API. This example was pulled from the automatic API documentation provided by Mealie.
|
||||
Mealie supports long-live api tokens in the user frontend. In you profile section you can use the
|
||||
|
||||
### Curl
|
||||
```bash
|
||||
|
|
@ -36,4 +36,4 @@ Recipes extras are a key feature of the Mealie API. They allow you to create cus
|
|||
|
||||
For example you could add `{"message": "Remember to thaw the chicken"}` to a recipe and use the webhooks built into mealie to send that message payload to a destination to be processed.
|
||||
|
||||
|
||||
|
||||
|
|
@ -7,7 +7,6 @@ To deploy mealie on your local network it is highly recommended to use docker to
|
|||
[Mealie on Dockerhub](https://hub.docker.com/r/hkotel/mealie)
|
||||
|
||||
- linux/amd64
|
||||
- linux/arm/v7
|
||||
- linux/arm64
|
||||
|
||||
|
||||
|
|
@ -76,20 +75,21 @@ services:
|
|||
|
||||
## Env Variables
|
||||
|
||||
| Variables | Default | Description |
|
||||
| ----------------- | ------------------ | ----------------------------------------------------------------------------------- |
|
||||
| DEFAULT_GROUP | Home | The default group for users |
|
||||
| DEFAULT_EMAIL | changeme@email.com | The default username for the superuser |
|
||||
| DB_ENGINE | sqlite | Optional: 'sqlite', 'postgres' |
|
||||
| POSTGRES_USER | mealie | Postgres database user |
|
||||
| POSTGRES_PASSWORD | mealie | Postgres database password |
|
||||
| POSTGRES_SERVER | postgres | Postgres database server address |
|
||||
| POSTGRES_PORT | 5432 | Postgres database port |
|
||||
| POSTGRES_DB | mealie | Postgres database name |
|
||||
| TOKEN_TIME | 2 | The time in hours that a login/auth token is valid |
|
||||
| API_PORT | 9000 | The port exposed by backend API. **do not change this if you're running in docker** |
|
||||
| API_DOCS | True | Turns on/off access to the API documentation locally. |
|
||||
| TZ | UTC | Must be set to get correct date/time on the server |
|
||||
| Variables | Default | Description |
|
||||
| ----------------- | --------------------- | ----------------------------------------------------------------------------------- |
|
||||
| DEFAULT_GROUP | Home | The default group for users |
|
||||
| DEFAULT_EMAIL | changeme@email.com | The default username for the superuser |
|
||||
| BASE_URL | http://localhost:8080 | Used for Notifications |
|
||||
| DB_ENGINE | sqlite | Optional: 'sqlite', 'postgres' |
|
||||
| POSTGRES_USER | mealie | Postgres database user |
|
||||
| POSTGRES_PASSWORD | mealie | Postgres database password |
|
||||
| POSTGRES_SERVER | postgres | Postgres database server address |
|
||||
| POSTGRES_PORT | 5432 | Postgres database port |
|
||||
| POSTGRES_DB | mealie | Postgres database name |
|
||||
| TOKEN_TIME | 2 | The time in hours that a login/auth token is valid |
|
||||
| API_PORT | 9000 | The port exposed by backend API. **do not change this if you're running in docker** |
|
||||
| API_DOCS | True | Turns on/off access to the API documentation locally. |
|
||||
| TZ | UTC | Must be set to get correct date/time on the server |
|
||||
|
||||
|
||||
!!! tip "Fatal Python error: init_interp_main: can't initialize time"
|
||||
|
|
@ -19,15 +19,5 @@ Below are some general guidelines that were considered when creating the organiz
|
|||
|
||||
In the diagram below you will see what we came up with using the new custom pages feature. The large circles indicate pages, and the rectangles indicate categories. We've grouped several 'like' categories with each other as a way to quickly find similar items.
|
||||
|
||||
|
||||
|
||||
|
||||
## Toolbox
|
||||
The toolbox gives you multiple options to clean-up and organize your recipes. You can acces it through the 'Settings' menu or through the [dashboard](../site-administration/dashboard.md).
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
The 'Organize' tab can be used to show all of the items that do not have any category or tag assigned.
|
||||
|
||||
|
||||
4
docs/docs/documentation/toolbox/bulk-organize.md
Normal file
4
docs/docs/documentation/toolbox/bulk-organize.md
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
# Bulk Organize
|
||||
The 'Organize' tab can be used to show all of the items that do not have any category or tag assigned.
|
||||
|
||||
|
||||
5
docs/docs/documentation/toolbox/category-tag-editor.md
Normal file
5
docs/docs/documentation/toolbox/category-tag-editor.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
# 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.
|
||||
|
||||
|
||||
|
|
@ -47,13 +47,13 @@ New events can be created and viewed in admin Toolbox `/admin/toolbox?tab=event-
|
|||
!!! 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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### Discord
|
||||
|
||||
|
||||
|
||||
### Gotify
|
||||
|
||||
|
||||
|
|
@ -9,5 +9,5 @@ To edit the meal in a meal plan simply select the edit button on the card in the
|
|||
## Shopping Lists
|
||||
For any meal plan created you can view a breakdown of all the ingredients and use an experimental sort function to sort similarly ingredients. This is a very new feature and results of the auto sort may vary.
|
||||
|
||||
|
||||
|
||||
|
||||
1
docs/docs/documentation/users-groups/shopping-lists.md
Normal file
1
docs/docs/documentation/users-groups/shopping-lists.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Shopping Lists
|
||||
|
|
@ -14,7 +14,7 @@ In as users profile they are able to
|
|||
## Themes
|
||||
Color themes can be created and set from the UI in the users settings 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.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! tip
|
||||
Theme data is stored in local storage in the browser. Calling "Save colors and apply theme will refresh the local storage with the selected theme as well save the theme to the database.
|
||||
File diff suppressed because one or more lines are too long
8
docs/docs/overrides/main.html
Normal file
8
docs/docs/overrides/main.html
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
{% extends "base.html" %} {% block analytics %}
|
||||
<script
|
||||
async
|
||||
defer
|
||||
data-domain="hay-kot.github.io/mealie"
|
||||
src="https://plausible.io/js/plausible.js"
|
||||
></script>
|
||||
{% endblock %}
|
||||
|
|
@ -17,7 +17,7 @@ theme:
|
|||
custom_dir: docs/overrides
|
||||
features:
|
||||
- navigation.top
|
||||
- navigation.instant
|
||||
# - navigation.instant
|
||||
- navigation.expand
|
||||
- navigation.sections
|
||||
- navigation.tabs
|
||||
|
|
@ -49,27 +49,38 @@ repo_name: hay-kot/mealie
|
|||
nav:
|
||||
- Home: "index.md"
|
||||
- Getting Started:
|
||||
- Introduction: "getting-started/introduction.md"
|
||||
- Installation: "getting-started/install.md"
|
||||
- Updating: "getting-started/updating.md"
|
||||
- Working With Recipes: "getting-started/recipes.md"
|
||||
- Organizing Recipes: "getting-started/organizing-recipes.md"
|
||||
- Planning Meals: "getting-started/meal-planner.md"
|
||||
- External Notifications: "getting-started/notifications.md"
|
||||
- API Usage: "getting-started/api-usage.md"
|
||||
- Site Administration:
|
||||
- Dashboard: "site-administration/dashboard.md"
|
||||
- User Settings: "site-administration/user-settings.md"
|
||||
- Site Settings: "site-administration/site-settings.md"
|
||||
- Building Pages: "site-administration/building-pages.md"
|
||||
- User Management: "site-administration/user-management.md"
|
||||
- Backups and Restore: "site-administration/backups-and-exports.md"
|
||||
- Recipe Migration: "site-administration/migration-imports.md"
|
||||
- Introduction: "documentation/getting-started/introduction.md"
|
||||
- Installation: "documentation/getting-started/install.md"
|
||||
- Updating: "documentation/getting-started/updating.md"
|
||||
- API: "documentation/getting-started/api-usage.md"
|
||||
|
||||
- Recipes:
|
||||
- Working With Recipes: "documentation/recipes/recipes.md"
|
||||
- Organizing Recipes: "documentation/recipes/organizing-recipes.md"
|
||||
|
||||
- Users & Groups:
|
||||
- User Settings: "documentation/users-groups/user-settings.md"
|
||||
- Planning Meals: "documentation/users-groups/meal-planner.md"
|
||||
- Shopping Lists: "documentation/users-groups/shopping-lists.md"
|
||||
|
||||
- Admin:
|
||||
- Dashboard: "documentation/admin/dashboard.md"
|
||||
- Site Settings: "documentation/admin/site-settings.md"
|
||||
- Building Pages: "documentation/admin/building-pages.md"
|
||||
- User Management: "documentation/admin/user-management.md"
|
||||
- Backups and Restore: "documentation/admin/backups-and-exports.md"
|
||||
- Recipe Migration: "documentation/admin/migration-imports.md"
|
||||
- Toolbox:
|
||||
- Event Notifications: "documentation/toolbox/notifications.md"
|
||||
- Category Tag Editor: "documentation/toolbox/category-tag-editor.md"
|
||||
- Bulk Organizer: "documentation/toolbox/bulk-organize.md"
|
||||
|
||||
- Community Guides:
|
||||
- iOS Shortcuts: "community-guide/ios.md"
|
||||
- Reverse Proxy (SWAG): "community-guide/swag.md"
|
||||
- Home Assistant: "community-guide/home-assistant.md"
|
||||
- Bulk Url Import: "community-guide/bulk-url-import.md"
|
||||
- iOS Shortcuts: "documentation/community-guide/ios.md"
|
||||
- Reverse Proxy (SWAG): "documentation/community-guide/swag.md"
|
||||
- Home Assistant: "documentation/community-guide/home-assistant.md"
|
||||
- Bulk Url Import: "documentation/community-guide/bulk-url-import.md"
|
||||
|
||||
- API Reference: "api/redoc.md"
|
||||
- Contributors Guide:
|
||||
- Non-Code: "contributors/non-coders.md"
|
||||
|
|
|
|||
|
|
@ -110,15 +110,19 @@ export default {
|
|||
this.$refs.deleteRecipieConfirm.open();
|
||||
break;
|
||||
case "share":
|
||||
if (navigator.share){
|
||||
navigator.share({
|
||||
title: this.name,
|
||||
text: this.recipeText,
|
||||
url: this.recipeURL,
|
||||
})
|
||||
.then(() => console.log('Successful share'))
|
||||
.catch((error) => console.log('WebShareAPI not supported', error))
|
||||
} else this.updateClipboard();
|
||||
if (navigator.share) {
|
||||
navigator
|
||||
.share({
|
||||
title: this.name,
|
||||
text: this.recipeText,
|
||||
url: this.recipeURL,
|
||||
})
|
||||
.then(() => console.log("Successful share"))
|
||||
.catch(error => {
|
||||
console.log("WebShareAPI not supported", error);
|
||||
this.updateClipboard();
|
||||
});
|
||||
} else this.updateClipboard();
|
||||
break;
|
||||
case "edit":
|
||||
this.$router.push(`/recipe/${this.slug}` + "?edit=true");
|
||||
|
|
@ -138,10 +142,13 @@ export default {
|
|||
updateClipboard() {
|
||||
const copyText = this.recipeURL;
|
||||
navigator.clipboard.writeText(copyText).then(
|
||||
() => { console.log("Copied to Clipboard", copyText);
|
||||
utils.notify.success("Copied to Clipboard");},
|
||||
() => console.log("Copied Failed", copyText));
|
||||
() => {
|
||||
console.log("Copied to Clipboard", copyText);
|
||||
utils.notify.success("Copied to Clipboard");
|
||||
},
|
||||
() => console.log("Copied Failed", copyText)
|
||||
);
|
||||
},
|
||||
},
|
||||
}
|
||||
};
|
||||
</script>
|
||||
|
|
|
|||
|
|
@ -215,7 +215,7 @@
|
|||
"ingredient": "Ingredient",
|
||||
"ingredients": "Ingredients",
|
||||
"instructions": "Instructions",
|
||||
"share-recipe-message": "I wanted to share you my {0} recipe.",
|
||||
"share-recipe-message": "I wanted to share my {0} recipe with you.",
|
||||
"key-name-required": "Key Name Required",
|
||||
"landscape-view-coming-soon": "Landscape View (Coming Soon)",
|
||||
"milligrams": "milligrams",
|
||||
|
|
|
|||
Loading…
Reference in a new issue