e34079673c
* 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>
102 lines
3.7 KiB
YAML
102 lines
3.7 KiB
YAML
site_name: Mealie
|
|
demo_url: https://mealie-demo.hay-kot.dev/
|
|
site_url: https://hay-kot.github.io/mealie/
|
|
use_directory_urls: true
|
|
theme:
|
|
palette:
|
|
# Light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: mealie
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
# Dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
custom_dir: docs/overrides
|
|
features:
|
|
- navigation.top
|
|
# - navigation.instant
|
|
- navigation.expand
|
|
- navigation.sections
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
favicon: assets/img/favicon.png
|
|
name: material
|
|
icon:
|
|
logo: material/silverware-variant
|
|
|
|
markdown_extensions:
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
- def_list
|
|
- pymdownx.highlight
|
|
- pymdownx.superfences
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- admonition
|
|
- attr_list
|
|
- pymdownx.tabbed
|
|
- pymdownx.superfences
|
|
|
|
extra_css:
|
|
- assets/stylesheets/custom.css
|
|
repo_url: https://github.com/hay-kot/mealie
|
|
repo_name: hay-kot/mealie
|
|
|
|
nav:
|
|
- Home: "index.md"
|
|
- Getting Started:
|
|
- 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"
|
|
|
|
- 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:
|
|
- External Notifications: "documentation/toolbox/notifications.md"
|
|
- Organization Tools: "documentation/toolbox/organize-tools.md"
|
|
|
|
- Community Guides:
|
|
- 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"
|
|
- Translating: "contributors/translating.md"
|
|
- Developers Guide:
|
|
- Code Contributions: "contributors/developers-guide/code-contributions.md"
|
|
- Dev Getting Started: "contributors/developers-guide/starting-dev-server.md"
|
|
- Guidelines: "contributors/developers-guide/general-guidelines.md"
|
|
- Style Guide: "contributors/developers-guide/style-guide.md"
|
|
- Development Road Map: "roadmap.md"
|
|
- Change Log:
|
|
- v0.5.0 General Upgrades: "changelog/v0.5.0.md"
|
|
- v0.4.3 Hot Fix: "changelog/v0.4.3.md"
|
|
- v0.4.2 Backend/Migrations: "changelog/v0.4.2.md"
|
|
- v0.4.1 Frontend/UI: "changelog/v0.4.1.md"
|
|
- v0.4.0 Authentication: "changelog/v0.4.0.md"
|
|
- v0.3.0 Improvements: "changelog/v0.3.0.md"
|
|
- v0.2.0 Now With Tests!: "changelog/v0.2.0.md"
|
|
- v0.1.0 Beta: "changelog/v0.1.0.md"
|