mirror of
https://github.com/mealie-recipes/mealie.git
synced 2025-08-02 20:15:24 +02:00
documentation updates
This commit is contained in:
parent
7b6fdc7619
commit
79f957eb8c
12 changed files with 82 additions and 36 deletions
|
@ -1,5 +0,0 @@
|
|||
# API Examples
|
||||
|
||||
TODO
|
||||
|
||||
Have Ideas? Submit a PR!
|
14
docs/docs/api/api-usage.md
Normal file
14
docs/docs/api/api-usage.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
# Usage
|
||||
|
||||
## Key Components
|
||||
### Recipe Extras
|
||||
Recipes extras are a key feature of the Mealie API. They allow you to create custom json key/value pairs within a recipe to reference from 3rd part applications. You can use these keys to contain information to trigger automation or custom messages to relay to your desired device.
|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
Have Ideas? Submit a PR!
|
|
@ -1,5 +1,26 @@
|
|||
# Release Notes
|
||||
|
||||
## v0.0.2 - Pre-release Second Patch
|
||||
A quality update with major props to [zackbcom](https://github.com/zackbcom) for working hard on making the theming just that much better!
|
||||
### Bug Fixes
|
||||
- Fixed opacity issues with marked steps - [mtoohey31](https://github.com/mtoohey31)
|
||||
- Fixed hot-reloading development environment - [grssmnn](https://github.com/grssmnn)
|
||||
- Fixed recipe not saving without image
|
||||
- Fixed parsing error on image property null
|
||||
|
||||
### General Improvements
|
||||
- Added Confirmation component to deleting recipes - [zackbcom](https://github.com/zackbcom)
|
||||
- Updated Theme backend - [zackbcom](https://github.com/zackbcom)
|
||||
- Added Persistent storage to vuex - [zackbcom](https://github.com/zackbcom)
|
||||
- General Color/Theme Improvements
|
||||
- More consistent UI
|
||||
- More minimalist coloring
|
||||
- Added API key extras to Recipe Data - [See Documentation](/api/api-usage/)
|
||||
- Users can now add custom json key/value pairs to all recipes via the editor for access in 3rd part applications. For example users can add a "message" field in the extras that can be accessed on API calls to play a message over google home.
|
||||
- Improved image rendering (nearly x2 speed)
|
||||
- Improved documentation + API Documentation
|
||||
- Improved recipe parsing
|
||||
|
||||
## v0.0.1 - Pre-release Patch
|
||||
### General
|
||||
- Updated Favicon
|
||||
|
|
BIN
docs/docs/gifs/api-extras.gif
Normal file
BIN
docs/docs/gifs/api-extras.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 14 MiB |
|
@ -10,7 +10,7 @@
|
|||
·
|
||||
<a href="https://github.com/hay-kot/mealie/issues">Report Bug</a>
|
||||
·
|
||||
<a href="/api/docs">API</a>
|
||||
<a href="https://hay-kot.github.io/mealie/api/docs/">API</a>
|
||||
·
|
||||
<a href="https://github.com/hay-kot/mealie/issues">
|
||||
Request Feature
|
||||
|
|
|
@ -28,7 +28,6 @@ Feature placement is not set in stone. This is much more of a guideline than any
|
|||
* [ ] Basic Form Validation
|
||||
- [ ] Recipe Viewer
|
||||
* [ ] Print Page View - Like King Arthur Website
|
||||
* [ ] Notes Hidden/Not Hidden
|
||||
* [ ] Total Time Indicator
|
||||
* [ ] Bake Time
|
||||
|
||||
|
|
|
@ -1,12 +1,12 @@
|
|||
site_name: Mealie Docs
|
||||
|
||||
theme:
|
||||
features:
|
||||
- navigation.expand
|
||||
favicon: img/favicon.png
|
||||
name: material
|
||||
icon:
|
||||
logo: material/silverware-variant
|
||||
features:
|
||||
- navigation.expand
|
||||
|
||||
markdown_extensions:
|
||||
- pymdownx.emoji:
|
||||
|
@ -34,8 +34,8 @@ nav:
|
|||
- Backups and Exports: "getting-started/backups-and-exports.md"
|
||||
- Recipe Migration: "getting-started/migration-imports.md"
|
||||
- API Reference:
|
||||
- API Usage: "api/api-usage.md"
|
||||
- API Documentation: "api/docs/index.html"
|
||||
- Usage Examples: "api/api-examples.md"
|
||||
- Contributors Guide:
|
||||
- Non-Code: "contributors/non-coders.md"
|
||||
- Developers Guide:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue