diff --git a/README.md b/README.md index ba92af1..cb41b3a 100644 --- a/README.md +++ b/README.md @@ -58,17 +58,17 @@ Our architecture is engineered for performance, scalability, and security. The f ```mermaid graph TD subgraph Client - A[Client Application\n(Web / Mobile / Voice)] + A[Client Application
(Web / Mobile / Voice)] end subgraph CDN B[CDN / Cache] end subgraph Server C[Bun Native Server] - E[NLP Engine &\nLanguage Processing Module] + E[NLP Engine &
Language Processing Module] end subgraph Integration - D[Home Assistant\n(Devices, Lights, Thermostats)] + D[Home Assistant
(Devices, Lights, Thermostats)] end A -->|HTTP Request| B diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css new file mode 100644 index 0000000..b6a4017 --- /dev/null +++ b/docs/assets/stylesheets/extra.css @@ -0,0 +1,28 @@ +:root { + --md-primary-fg-color: #1a73e8; + --md-primary-fg-color--light: #5195ee; + --md-primary-fg-color--dark: #0d47a1; +} + +.md-header { + box-shadow: 0 0 0.2rem rgba(0,0,0,.1), 0 0.2rem 0.4rem rgba(0,0,0,.2); +} + +.md-main__inner { + margin-top: 1.5rem; +} + +.md-typeset h1 { + font-weight: 700; + color: var(--md-primary-fg-color); +} + +.md-typeset .admonition { + font-size: .8rem; +} + +code { + background-color: rgba(175,184,193,0.2); + padding: .2em .4em; + border-radius: 6px; +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index b9765e4..06c83c4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,26 +1,110 @@ -site_name: Home Assistant Model Context Protocol (MCP) +site_name: Home Assistant MCP +site_description: A bridge between Home Assistant and Language Learning Models site_url: https://jango-blockchained.github.io/advanced-homeassistant-mcp/ repo_url: https://github.com/jango-blockchained/advanced-homeassistant-mcp +repo_name: jango-blockchained/advanced-homeassistant-mcp theme: name: material + logo: assets/images/logo.png + favicon: assets/images/favicon.ico + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: indigo + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: indigo + accent: indigo + toggle: + icon: material/brightness-4 + name: Switch to light mode features: - - navigation.tabs + - navigation.instant + - navigation.tracking - navigation.sections - - toc.integrate + - navigation.expand + - navigation.top - search.suggest - search.highlight + - content.code.copy markdown_extensions: - - pymdownx.highlight - - pymdownx.superfences - admonition + - attr_list + - def_list + - footnotes + - meta + - toc: + permalink: true + - pymdownx.arithmatex: + generic: true + - pymdownx.betterem: + smart_enable: all + - pymdownx.caret - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.keys + - pymdownx.magiclink + - pymdownx.mark + - pymdownx.smartsymbols + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + +plugins: + - search + - minify: + minify_html: true + - git-revision-date-localized: + type: date + - mkdocstrings: + default_handler: python + handlers: + python: + options: + show_source: true nav: - Home: index.md - Getting Started: - Installation: getting-started/installation.md - - Configuration: getting-started/configuration.md - - Usage: usage.md - - Contributing: contributing.md \ No newline at end of file + - Quick Start: getting-started/quickstart.md + - API Reference: + - Overview: api/index.md + - SSE API: api/sse.md + - Core Functions: api/core.md + - Architecture: architecture.md + - Contributing: contributing.md + - Troubleshooting: troubleshooting.md + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/jango-blockchained/homeassistant-mcp + - icon: fontawesome/brands/docker + link: https://hub.docker.com/r/jangoblockchained/homeassistant-mcp + analytics: + provider: google + property: !ENV GOOGLE_ANALYTICS_KEY + +extra_css: + - assets/stylesheets/extra.css + +copyright: Copyright © 2024 Jango Blockchained \ No newline at end of file