Files
homeassistant-mcp/mkdocs.yml
jango-blockchained 61e930bf8a docs: Refactor documentation structure and enhance project overview
- Update MkDocs configuration with streamlined navigation and theme improvements
- Revise README with comprehensive project introduction and key features
- Add new documentation pages for NLP, custom prompts, and extras
- Enhance index page with system architecture diagram and getting started guide
- Improve overall documentation clarity and organization
2025-02-06 10:06:27 +01:00

107 lines
2.8 KiB
YAML

site_name: Home Assistant MCP
site_url: https://jango-blockchained.github.io/homeassistant-mcp
repo_url: https://github.com/jango-blockchained/homeassistant-mcp
repo_name: jango-blockchained/homeassistant-mcp
edit_uri: edit/main/docs/
theme:
name: material
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.indexes
- toc.follow
- search.suggest
- search.highlight
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
icon:
repo: fontawesome/brands/github
favicon: assets/favicon.png
logo: assets/logo.png
plugins:
- search
- mermaid2
- git-revision-date-localized:
type: date
- minify:
minify_html: true
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- meta
- toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- 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
nav:
- Home: index.md
- Getting Started:
- Quick Start: getting-started/quick-start.md
- Installation: getting-started/installation.md
- Configuration: getting-started/configuration.md
- Features:
- Core Features: features/core-features.md
- Speech Processing: features/speech-processing.md
- NLP Integration: features/nlp.md
- Custom Prompts: features/prompts.md
- Tools & Extras:
- Overview: tools/overview.md
- Analyzer CLI: tools/analyzer-cli.md
- Speech Examples: tools/speech-examples.md
- Claude Desktop: tools/claude-desktop.md
- API Reference:
- Overview: api/overview.md
- REST API: api/rest.md
- WebSocket API: api/websocket.md
- Events: api/events.md
- Development:
- Setup: development/setup.md
- Contributing: development/contributing.md
- Testing: development/testing.md
- Troubleshooting:
- Common Issues: troubleshooting/common-issues.md
- FAQ: troubleshooting/faq.md
- About:
- License: about/license.md
- Author: about/author.md