improve docs

2026-04-15 23:07:52 +02:00
parent bfb6432666
commit 395182649b
13 changed files with 1004 additions and 33 deletions
@@ -0,0 +1,66 @@
+site_name: BincioActivity
+site_description: Federated, open-source, self-hosted activity stats platform
+site_author: Davide Brugali
+repo_url: https://github.com/brutsalvadi/bincio-activity
+repo_name: brutsalvadi/bincio-activity
+edit_uri: edit/main/docs/
+
+docs_dir: docs
+site_dir: mkdocs-site
+
+theme:
+  name: material
+  palette:
+    - scheme: light
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to dark mode
+    - scheme: slate
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/lightbulb
+        name: Switch to light mode
+  features:
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.code.copy
+    - content.code.annotate
+
+plugins:
+  - search
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      use_pygments: true
+  - pymdownx.inlinehilite
+  - pymdownx.tabbed:
+      alternate_style: true
+  - toc:
+      permalink: true
+
+nav:
+  - Home: index.md
+  - Getting Started: getting-started.md
+  - User Guide: user-guide.md
+  - Admin Guide: admin-guide.md
+  - Deployment:
+      - Single-user: deployment/single-user.md
+      - Multi-user: deployment/multi-user.md
+      - VPS: deployment/vps.md
+  - Developer:
+      - Developer Guide: developer-guide.md
+      - Architecture: architecture.md
+  - Reference:
+      - API: reference/api.md
+      - CLI: reference/cli.md
+      - Schema: schema.md
+  - Garmin Disclaimer: garmin_connect_disclaimer.md