site_name: S.T.A.R.K. Docs
site_author: Mark Parker
site_description: Speach and Text Algorithmic Recognition Kit (S.T.A.R.K.) is a set of tools for building custom voice assistants. It is designed to be modular and extensible, allowing you to build your own custom voice assistant with ease.
# site_url: https://markparker5.github.io/stark

repo_name: MarkParker5/STARK
repo_url: https://github.com/MarkParker5/STARK


copyright: Copyright © Mark Parker

nav:
  - Home: home.md # Home, description, all features list, where to find commands, license, usefull links
  - Contributing and Shared Usage: contributing-and-shared-usage.md # Contributing, shared usage, code of conduct, license
  - Installation: installation.md
  - First Steps: first-steps.md
  - Sync vs Async Commands: sync-vs-async-commands.md # TLDR and in depth about worker threads and asyncify
  - Creating Commands: creating-commands.md # manager.new, join managers, return, yield (async, sync), handler.respond and unrespond (sync and async), call subcommands (sync and async)
  - Patterns: patterns.md # pattern syntax, parameters parsing, native types, custom object types, nested objects, advanced parsing with did_parse
  - Command Response: command-response.md # every property explanation
  - Dependency Injection: dependency-injection.md # response handler, inject_dependency, get DIContainer, add custom dependency, create a custom container
  - Commands Context: commands-context.md # context explanation, adding context in response, pop context, multiple commands in request
  - Voice Assistant: voice-assistant.md # Modes, repeating, context handling
  - Default Speech Interfaces: # STT, TTS
  - Where to Host: where-to-host.md # personal computer: system.d or windows tray, raspberry pi: system.d, iOS: in development, android: not implemented
  - Advanced Usage:
    - Optimization: advanced/optimization.md # worker threads, asyncify, asyncer group, caching
    - Custom Run: advanced/custom-run.md # custom event loop, blocking detector, typer
    - Fallback Command: advanced/fallback-command.md # Fallback command setting and available implementations
    - External Triggers: advanced/external-triggers.md # external triggers
    - Localization and Multi-Language: advanced/localization-and-multi-language.md # TODO: Localization, multi-language
    - Custom Interfaces: advanced/custom-interfaces.md # stt, tts, text: telebot.
    # - Speech Recognition: advanced/speech-recognition.md # available engines, create custom
    # - Speech Synthesis: advanced/speech-synthesis.md # available engines, create custom
    - Voice Assistant: advanced/voice-assistant.md # methods for overrides
    - Commands Context: advanced/commands-context.md # methods for overrides
    - Other: # read the code


theme:
  name: material
  custom_dir: overrides
  language: en

  icon:
    repo: fontawesome/brands/github

  features:
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.indexes
    - navigation.instant
    # - navigation.instant.prefetch
    - navigation.path
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  palette: 

    # Palette toggle for automatic mode
    # - media: "(prefers-color-scheme)"
    #   primary: orange
    #   accent: orange
    #   toggle:
    #     icon: material/brightness-auto
    #     name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: orange
      accent: orange
      scheme: default 
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: orange
      accent: orange
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to system preference

extra:
  generator: false
  
  social:
    - icon: fontawesome/brands/github 
      link: https://github.com/ParkerIndustries
  
  features:
    - navigation.footer

  analytics:
    provider: google
    property: G-NMVH5RVSYB

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - toc:
      permalink: true

plugins:
  - offline
  - search
  - social
  # - optimize
  # - tags
  - swagger-ui-tag
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  # - git-committers:
  #     repository: MarkParker5/STARK
  #     branch: master