mirror of
https://github.com/mealie-recipes/mealie.git
synced 2025-05-24 01:12:54 -04:00
3c2744a3da
* add basic pre-commit file * add flake8 * add isort * add pep585-upgrade (typing upgrades) * use namespace for import * add mypy * update ci for backend * flake8 scope * fix version format * update makefile * disable strict option (temporary) * fix mypy issues * upgrade type hints (pre-commit) * add vscode typing check * add types to dev deps * remote container draft * update setup script * update compose version * run setup on create * dev containers update * remove unused pages * update setup tips * expose ports * Update pre-commit to include flask8-print (#1053) * Add in flake8-print to pre-commit * pin version of flake8-print * formatting * update getting strated docs * add mypy to pre-commit * purge .mypy_cache on clean * drop mypy Co-authored-by: zackbcom <zackbcom@users.noreply.github.com>
100 lines
3.5 KiB
YAML
100 lines
3.5 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:
|
|
- content.code.annotate
|
|
- 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
|
|
extra_javascript:
|
|
- assets/js/extra.js
|
|
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"
|
|
- Updating: "documentation/getting-started/updating.md"
|
|
- Version 1 Migration: "documentation/getting-started/migrating-to-mealie-v1.md"
|
|
- FAQ: "documentation/getting-started/faq.md"
|
|
- API: "documentation/getting-started/api-usage.md"
|
|
- Road Map: "documentation/getting-started/roadmap.md"
|
|
|
|
- Installation:
|
|
- Installation Checklist: "documentation/getting-started/installation/installation-checklist.md"
|
|
- SQLite (Recommended): "documentation/getting-started/installation/sqlite.md"
|
|
- PostgreSQL: "documentation/getting-started/installation/postgres.md"
|
|
- Frontend Configuration: "documentation/getting-started/installation/frontend-config.md"
|
|
- Backend Configuration: "documentation/getting-started/installation/backend-config.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"
|
|
- Guides:
|
|
- Improving Ingredient Parser: "contributors/guides/ingredient-parser.md"
|
|
|
|
- Change Log:
|
|
- v1.0.0 A Whole New App: "changelog/v1.0.0.md"
|
|
- v0.5.2 Misc Updates: "changelog/v0.5.2.md"
|
|
- v0.5.1 Bug Fixes: "changelog/v0.5.1.md"
|
|
- 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"
|