mkdocs.yml

# ModelDock Documentation
# MkDocs Material configuration

site_name: ModelDock
site_url: https://openagenthq.github.io/modeldock/
site_author: Himanshu kumar (OpenAgentHQ)
site_description: >-
  The lightweight, Python-first model manager for local AI models —
  the package manager for local LLMs.

repo_name: OpenAgentHQ/modeldock
repo_url: https://github.com/OpenAgentHQ/modeldock
edit_uri: edit/main/docs/

copyright: >-
  Copyright © 2026 OpenAgentHQ —
  <a href="https://github.com/OpenAgentHQ/modeldock/blob/main/LICENSE">MIT License</a>

# ── Theme ──────────────────────────────────────────────────────────────────

theme:
  name: material
  language: en
  logo: images/logo-header.png
  favicon: images/modeldock.png
  palette:
    # Light mode — respects the OS preference on first visit. Flat white
    # header/nav (no colored bar) in the style of modern docs platforms
    # like Mintlify.
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode — flat near-black header to match.
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  font:
    text: Inter
    code: JetBrains Mono

  icon:
    repo: fontawesome/brands/github

  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tabs.link
    - content.action.edit
    - content.action.view
    - content.tooltips
    - toc.follow
    - toc.integrate

# ── Navigation ─────────────────────────────────────────────────────────────

nav:
  - Home: index.md
  - Getting Started:
    - Quickstart: getting-started/quickstart.md
    - Installation: getting-started/installation.md
    - First Model: getting-started/first-model.md
  - User Guide:
    - Overview: user-guide/overview.md
    - Discover Models: user-guide/discover.md
    - Install & Manage: user-guide/install.md
    - Load & Run: user-guide/load.md
    - Cache Management: user-guide/cache.md
    - Configuration: user-guide/configuration.md
  - SDK Reference:
    - Python API: sdk/python-api.md
    - CLI Reference: sdk/cli.md
    - Ollama Integration: sdk/ollama.md
    - LM Studio Integration: sdk/lmstudio.md
    - llama.cpp Integration: sdk/llamacpp.md
  - Architecture:
    - Design Overview: architecture/overview.md
    - Clean Architecture: architecture/clean-architecture.md
    - Runtime Adapters: architecture/runtime-adapters.md
    - Catalog Provider Registry: architecture/catalog-provider-registry.md
    - Port Interfaces: architecture/ports.md
    - Error Handling: architecture/errors.md
  - Contributing:
    - Guidelines: contributing/guidelines.md
    - Development Setup: contributing/development.md
    - Adding Runtimes: contributing/new-runtime.md
    - Testing Strategy: contributing/testing.md
  - Project:
    - Vision: project/vision.md
    - Roadmap: project/roadmap.md
    - Changelog: project/changelog.md
    - Security: project/security.md
    - License: project/license.md

# ── Markdown Extensions ────────────────────────────────────────────────────

markdown_extensions:
  # Built-in
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - def_list
  - tables
  - toc:
      permalink: true
      permalink_title: Anchor link to this section
  - meta

# ── Plugins ────────────────────────────────────────────────────────────────

plugins:
  - search
  - minify:
      minify_html: true

# ── Extra ──────────────────────────────────────────────────────────────────

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/OpenAgentHQ/modeldock
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/modeldock/
  version:
    provider: mike
  generator: false

extra_css:
  - stylesheets/custom.css

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js