mkdocs.yml

site_name: Consoul Documentation
site_description: AI-powered terminal assistant with rich interactive TUI built on Textual and LangChain
site_author: Jared Rummler
site_url: https://jaredrummler.github.io/consoul/

# Repository
repo_name: jaredrummler/consoul
repo_url: https://github.com/jaredrummler/consoul
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2025 Jared Rummler

# Configuration
watch:
  - docs/overrides

theme:
  name: material
  custom_dir: docs/overrides
  favicon: assets/img/favicon.png
  logo: assets/img/consoul-top-bar.svg

  # Color scheme and branding
  palette:
    # Palette toggle for light mode (default)
    - 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

  # Typography - use system fonts for better performance
  font: false

  # Features
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  # Icons
  icon:
    repo: fontawesome/brands/github

# Plugins
plugins:
  - search:
      # Search word separator regex for optimal tokenization:
      # - [\s\-,:!=\[\]()"`/]+ : Split on whitespace and special characters
      # - \.(?!\d) : Split on periods (except in version numbers like 3.12)
      # - &[lg]t; : Split on HTML entities (< >)
      # - (?!\b)(?=[A-Z][a-z]) : Split camelCase/PascalCase (TUI, SDK, etc.)
      # This ensures terms like "TUI", "CLI", "SDK" are searchable as complete tokens
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
      lang: en
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - skip-lightbox
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            heading_level: 2
            inherited_members: true
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_toc_entry: false
            show_signature_annotations: true
            show_source: false
            show_submodules: false

# Customization
extra_css:
  - assets/css/consoul.css
  - assets/css/termynal.css
  - assets/css/copilot-style.css

extra_javascript:
  - assets/js/termynal.js
  - assets/js/custom.js

extra:
  homepage: https://jaredrummler.com
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jaredrummler/consoul
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/consoul/
    - icon: fontawesome/solid/globe
      link: https://jaredrummler.com
  generator: false

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: jaredrummler
      repo: consoul
  - 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

# Page tree
nav:
  - Home: index.md
  - Introduction:
    - Getting Started: user-guide/getting-started.md
    - Installation: installation.md
    - Quick Start: quickstart.md
    - Configuration: user-guide/configuration.md
  - TUI:
    - Overview: user-guide/tui.md
    - Interface Guide: user-guide/tui/interface.md
    - Features: user-guide/tui/features.md
    - Keyboard Shortcuts: user-guide/tui/keyboard-shortcuts.md
    - Modals & Dialogs: user-guide/tui/modals.md
    - Themes: user-guide/tui/themes.md
    - Configuration: user-guide/tui/configuration.md
  - SDK:
    - Overview: api/index.md
    - Tutorial: api/tutorial.md
    - Integration Guide: api/integration-guide.md
    - Model Registry: api/model-registry.md
    - Tools: api/tools.md
    - Tool Configuration: sdk-tools.md
    - Building Agents: api/agents.md
    - API Reference: api/reference.md
  - CLI:
    - Overview: cli-reference/index.md
    - Commands: user-guide/usage.md
    - Chat Mode: user-guide/cli-chat.md
  - Tools:
    - File Editing: user-guide/file-editing.md
    - Image Analysis: user-guide/image-analysis.md
    - Code Search: user-guide/code-search.md
  - Deployment:
    - Multi-Tenancy: deployment/multi-tenancy.md
    - Performance Tuning: deployment/performance-tuning.md
  - Operations:
    - Scaling Guide: operations/scaling-guide.md
    - Load Testing: operations/load-testing.md
    - API Key Rotation: operations/api-key-rotation.md
    - Security Checklist: operations/security-checklist.md
    - Runbook: operations/runbook.md
  - Advanced:
    - SearxNG Setup: advanced/searxng-setup.md
  - Development:
    - Setup: development.md
    - Architecture: development/architecture.md
    - Service Layer: development/service-layer.md
    - Testing: development/testing.md
    - Contributing: contributing.md
  - Security: SECURITY.md
  - FAQs: faqs.md