mkdocs.yml

site_name: holoviz-mcp
site_description: "A Model Context Protocol (MCP) server for the HoloViz ecosystem"
site_author: "MarcSkovMadsen"

repo_url: https://github.com/MarcSkovMadsen/holoviz-mcp
repo_name: MarcSkovMadsen/holoviz-mcp
edit_uri: edit/main/docs/

docs_dir: docs

theme:
    name: material
    logo: 'assets/logo.png'
    features:
        - announce.dismiss
        - content.action.edit
        - content.action.view
        - content.code.annotate
        - content.code.copy
        - content.tooltips
        - navigation.footer
        - navigation.indexes
        - navigation.sections
        - navigation.top
        - search.highlight
        - search.suggest
        - toc.follow
    palette:
        # Palette toggle for light mode
        - media: "(prefers-color-scheme: light)"
          scheme: default
          primary: white
          accent: blue
          toggle:
            icon: material/brightness-7
            name: Switch to dark mode

        # Palette toggle for dark mode
        - media: "(prefers-color-scheme: dark)"
          scheme: slate
          primary: black
          accent: blue
          toggle:
            icon: material/brightness-4
            name: Switch to light mode

markdown_extensions:
    - toc:
        permalink: true
    - pymdownx.highlight:
        anchor_linenums: true
    - pymdownx.tasklist:
        custom_checkbox: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - admonition
    - pymdownx.superfences:
        custom_fences:
          - name: python
            class: 'highlight'
            validator: !!python/name:mkdocs_pycafe.validator
            format: !!python/object/apply:mkdocs_pycafe.formatter
              kwds:
                type: panel
                requirements: |
                  # Add any other requirements here
                  # see https://mkdocs.py.cafe/en/latest/ for more info
                  panel
                  holoviz_mcp
                link_text: |
                  <img src="https://py.cafe/logos/pycafe_logo.png" style="height: 24px"> **Run and edit this code in Py.Cafe**
    - pymdownx.snippets:
        url_download: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: numpy
            show_if_no_docstring: true
            filters:
            - "!^_"

watch:
    - docs
    - src/holoviz_mcp

nav:
    - Home: index.md
    - Tutorials:
        - Getting Started:
            - Claude Code: tutorials/getting-started-claude-code.md
            - Claude Desktop: tutorials/getting-started-claude-desktop.md
            - Copilot + VS Code: tutorials/getting-started-copilot-vscode.md
            - Cursor: tutorials/getting-started-cursor.md
            - Windsurf: tutorials/getting-started-windsurf.md
        - Display System: tutorials/display-system.md
        - Projects:
            - Stock Analysis (Copilot): tutorials/stock-analysis-copilot-vscode.md
            - Stock Analysis (Claude): tutorials/stock-analysis-claude-code.md
            - Weather Dashboard (Copilot): tutorials/weather-dashboard-copilot-vscode.md
            - Weather Dashboard (Claude): tutorials/weather-dashboard-claude-code.md
    - Examples:
        - examples/index.md
        - Plot from Picture: examples/generate-plot-from-picture.md
        - Dashboard from Picture: examples/generate-dashboard-from-picture.md
        - Create ML Experiment Tracker: examples/create-ml-experiment-tracker.md
        - Build A Shipping Form: examples/build-a-shipping-form.md
        - Convert Excel Sheet: examples/convert-excel-app.md
        - Convert Streamlit App: examples/convert-streamlit-app.md
    - How-To Guides:
        - Installation:
            - uv (recommended): how-to/install-uv.md
            - pip: how-to/install-pip.md
            - conda: how-to/install-conda.md
            - Docker: how-to/install-docker.md
        - IDE Setup:
            - Claude Code: how-to/configure-claude-code.md
            - Claude Desktop: how-to/configure-claude-desktop.md
            - Copilot + VS Code: how-to/configure-vscode.md
            - Cursor: how-to/configure-cursor.md
            - Windsurf: how-to/configure-windsurf.md
        - Configuration:
            - Settings: how-to/configure-settings.md
            - Display Server: how-to/configure-display-server.md
            - Custom Docs: how-to/add-custom-docs.md
        - Docker:
            - Development: how-to/docker-development.md
            - Production: how-to/docker-production.md
        - Serve Apps: how-to/serve-apps.md
        - Update: how-to/update-holoviz-mcp.md
        - Troubleshooting: how-to/troubleshooting.md
    - Explanation:
        - Architecture: explanation/architecture.md
        - Available Tools: explanation/tools.md
        - Security Considerations: explanation/security.md
        - Display System: explanation/display-system.md
    - Reference:
        - API Documentation: reference/holoviz_mcp.md
    - Contributing: contributing.md
    - Code of Conduct: code-of-conduct.md

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/MarcSkovMadsen
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/panel_org
  - icon: fontawesome/brands/python
    link: https://pypi.org/project/holoviz-mcp
  - icon: fontawesome/brands/discourse
    link: https://discourse.holoviz.org/
  - icon: fontawesome/brands/discord
    link: https://discord.com/invite/rb6gPXbdAr
  - icon: fontawesome/brands/linkedin
    link: https://www.linkedin.com/company/panel-org