73 lines
2 KiB
YAML
73 lines
2 KiB
YAML
site_name: Kiwi
|
|
site_description: Pantry tracking and leftover recipe suggestions — scan barcodes, photograph receipts, and cook what you already have before it expires.
|
|
site_author: Circuit Forge LLC
|
|
site_url: https://docs.circuitforge.tech/kiwi
|
|
repo_url: https://git.opensourcesolarpunk.com/Circuit-Forge/kiwi
|
|
repo_name: Circuit-Forge/kiwi
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
- scheme: default
|
|
primary: green
|
|
accent: teal
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: green
|
|
accent: lime
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- pymdownx.details
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Installation: getting-started/installation.md
|
|
- Quick Start: getting-started/quick-start.md
|
|
- LLM Backend (Optional): getting-started/llm-setup.md
|
|
- User Guide:
|
|
- Inventory: user-guide/inventory.md
|
|
- Barcode Scanning: user-guide/barcode.md
|
|
- Receipt OCR: user-guide/receipt-ocr.md
|
|
- Recipe Browser: user-guide/recipes.md
|
|
- Saved Recipes: user-guide/saved-recipes.md
|
|
- Leftover Mode: user-guide/leftover-mode.md
|
|
- Settings: user-guide/settings.md
|
|
- Reference:
|
|
- Recipe Engine: reference/recipe-engine.md
|
|
- Tier System: reference/tier-system.md
|
|
- Architecture: reference/architecture.md
|
|
- All CF Docs: https://docs.circuitforge.tech
|
|
|
|
extra_css:
|
|
- stylesheets/theme.css
|
|
|
|
extra_javascript:
|
|
- plausible.js
|