diff --git a/docs/plausible.js b/docs/plausible.js new file mode 100644 index 0000000..769bf63 --- /dev/null +++ b/docs/plausible.js @@ -0,0 +1 @@ +(function(){var s=document.createElement("script");s.defer=true;s.dataset.domain="docs.circuitforge.tech,circuitforge.tech";s.dataset.api="https://analytics.circuitforge.tech/api/event";s.src="https://analytics.circuitforge.tech/js/script.js";document.head.appendChild(s);})(); diff --git a/frontend/index.html b/frontend/index.html index d6947bc..e11c19d 100644 --- a/frontend/index.html +++ b/frontend/index.html @@ -23,6 +23,9 @@ .app-body { display: flex; flex-direction: column; flex: 1; } } + +
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..6543b58 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,68 @@ +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: light green + accent: green + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + primary: light green + accent: green + 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 + - 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 + +extra_javascript: + - plausible.js