docs: update MkDocs configuration and documentation structure

- Refactor mkdocs.yml with new project name and simplified configuration
- Update GitHub Actions workflow to use MkDocs Material deployment
- Add new configuration files for Claude Desktop
- Reorganize documentation navigation and structure
- Update CSS and JavaScript references
This commit is contained in:
jango-blockchained
2025-02-05 12:44:26 +01:00
parent 3e7f3920b2
commit 13a27e1d00
5 changed files with 41 additions and 101 deletions

View File

@@ -1,23 +1,19 @@
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
site_name: Claude Desktop
site_url: https://your-username.github.io/your-repo-name
repo_url: https://github.com/your-username/your-repo-name
theme:
name: material
logo: assets/images/logo.png
favicon: assets/images/favicon.ico
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
- scheme: slate
primary: indigo
accent: indigo
toggle:
@@ -34,39 +30,15 @@ theme:
- content.code.copy
markdown_extensions:
- 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:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.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
- pymdownx.snippets
- pymdownx.superfences
- admonition
- pymdownx.details
- attr_list
- md_in_html
plugins:
- search
@@ -81,13 +53,17 @@ plugins:
nav:
- Home: index.md
- Usage: usage.md
- API: api.md
- Configuration:
- Claude Desktop Config: claude_desktop_config.md
- Cline Config: cline_config.md
- Getting Started:
- Overview: getting-started.md
- Installation: getting-started/installation.md
- Configuration: getting-started/configuration.md
- Docker Setup: getting-started/docker.md
- Quick Start: getting-started/quickstart.md
- Usage: usage.md
- API Reference:
- Overview: api/index.md
- Core API: api.md
@@ -136,6 +112,9 @@ extra:
property: !ENV GOOGLE_ANALYTICS_KEY
extra_css:
- assets/stylesheets/extra.css
- stylesheets/extra.css
extra_javascript:
- javascripts/extra.js
copyright: Copyright © 2024 Jango Blockchained