mirror of
https://github.com/hay-kot/mealie.git
synced 2025-08-23 06:45:22 -07:00
reorganize docs
This commit is contained in:
parent
bd3d6c8a3d
commit
65fbde1ee1
12 changed files with 29 additions and 13 deletions
BIN
docs/docs/assets/img/discord-notification-example.webp
Normal file
BIN
docs/docs/assets/img/discord-notification-example.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 40 KiB |
BIN
docs/docs/assets/img/gotify-notification-example.webp
Normal file
BIN
docs/docs/assets/img/gotify-notification-example.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
2
docs/docs/community-guide/.header.md
Normal file
2
docs/docs/community-guide/.header.md
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
!!! info
|
||||||
|
This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed!
|
|
@ -1,5 +1,5 @@
|
||||||
!!! info
|
!!! info
|
||||||
This example was submitted by a user. Have an Example? Submit a PR!
|
This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed!
|
||||||
|
|
||||||
|
|
||||||
Recipes can be imported in bulk from a file containing a list of URLs. This can be done using the following bash or python scripts with the `list` file containing one URL per line.
|
Recipes can be imported in bulk from a file containing a list of URLs. This can be done using the following bash or python scripts with the `list` file containing one URL per line.
|
|
@ -1,3 +1,7 @@
|
||||||
|
!!! info
|
||||||
|
This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed!
|
||||||
|
|
||||||
|
|
||||||
In a lot of ways, Home Assistant is why this project exists! Since it Mealie has a robust API it makes it a great fit for interacting with Home Assistant and pulling information into your dashboard.
|
In a lot of ways, Home Assistant is why this project exists! Since it Mealie has a robust API it makes it a great fit for interacting with Home Assistant and pulling information into your dashboard.
|
||||||
|
|
||||||
### Get Todays Meal in Lovelace
|
### Get Todays Meal in Lovelace
|
|
@ -1,4 +1,9 @@
|
||||||
# Using iOS Shortcuts with Mealie
|
# Using iOS Shortcuts with Mealie
|
||||||
|
|
||||||
|
!!! info
|
||||||
|
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"}
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,10 @@
|
||||||
# Using SWAG as Reverse Proxy
|
# Using SWAG as Reverse Proxy
|
||||||
|
|
||||||
|
!!! info
|
||||||
|
This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
To make the setup of a Reverse Proxy much easier, Linuxserver.io developed [SWAG](https://github.com/linuxserver/docker-swag)
|
To make the setup of a Reverse Proxy much easier, Linuxserver.io developed [SWAG](https://github.com/linuxserver/docker-swag)
|
||||||
SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx web server and reverse proxy with PHP support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention.
|
SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx web server and reverse proxy with PHP support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention.
|
||||||
|
|
||||||
|
|
|
@ -47,13 +47,13 @@ New events can be created and viewed in admin Toolbox `/admin/toolbox?tab=event-
|
||||||
!!! tip
|
!!! 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.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
### Discord
|
### Discord
|
||||||
![Discord]()
|

|
||||||
|
|
||||||
### Gotify
|
### Gotify
|
||||||
![Gotify]()
|

|
|
@ -19,7 +19,7 @@ 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.
|
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
|
## 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 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).
|
||||||
|
|
File diff suppressed because one or more lines are too long
|
@ -56,20 +56,20 @@ nav:
|
||||||
- Organizing Recipes: "getting-started/organizing-recipes.md"
|
- Organizing Recipes: "getting-started/organizing-recipes.md"
|
||||||
- Planning Meals: "getting-started/meal-planner.md"
|
- Planning Meals: "getting-started/meal-planner.md"
|
||||||
- External Notifications: "getting-started/notifications.md"
|
- External Notifications: "getting-started/notifications.md"
|
||||||
- iOS Shortcuts: "getting-started/ios.md"
|
- API Usage: "getting-started/api-usage.md"
|
||||||
- Site Administration:
|
- Site Administration:
|
||||||
|
- Dashboard: "site-administration/dashboard.md"
|
||||||
- User Settings: "site-administration/user-settings.md"
|
- User Settings: "site-administration/user-settings.md"
|
||||||
- Site Settings: "site-administration/site-settings.md"
|
- Site Settings: "site-administration/site-settings.md"
|
||||||
- Building Pages: "site-administration/building-pages.md"
|
- Building Pages: "site-administration/building-pages.md"
|
||||||
- User Management: "site-administration/user-management.md"
|
- User Management: "site-administration/user-management.md"
|
||||||
- Dashboard: "site-administration/dashboard.md"
|
|
||||||
- Backups and Restore: "site-administration/backups-and-exports.md"
|
- Backups and Restore: "site-administration/backups-and-exports.md"
|
||||||
- Recipe Migration: "site-administration/migration-imports.md"
|
- Recipe Migration: "site-administration/migration-imports.md"
|
||||||
- API Usage:
|
- Community Guides:
|
||||||
- Getting Started: "api-usage/getting-started.md"
|
- iOS Shortcuts: "community-guide/ios.md"
|
||||||
- Home Assistant: "api-usage/home-assistant.md"
|
- Reverse Proxy (SWAG): "community-guide/swag.md"
|
||||||
- Bulk Url Import: "api-usage/bulk-url-import.md"
|
- Home Assistant: "community-guide/home-assistant.md"
|
||||||
- Community Guide: "community-guide/swag.md"
|
- Bulk Url Import: "community-guide/bulk-url-import.md"
|
||||||
- API Reference: "api/redoc.md"
|
- API Reference: "api/redoc.md"
|
||||||
- Contributors Guide:
|
- Contributors Guide:
|
||||||
- Non-Code: "contributors/non-coders.md"
|
- Non-Code: "contributors/non-coders.md"
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue