mkdocs.yml

site_name: 'KnitPkg Documentation'
site_description: 'A modern package & project manager for MQL5/MQL4'
site_url: 'https://docs.knitpkg.dev/'
repo_url: 'https://github.com/knitpkg-dev/knitpkg-mt'
repo_name: 'knitpkg-dev/knitpkg-mt'

theme:
  name: material
  logo: assets/kp-logo.svg
  favicon: assets/kp-logo.svg

  palette:
    # Dark mode (primary)
    - scheme: slate
      primary: custom  # We'll define custom colors below
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    # Light mode (optional, but keeping dark as default)
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - announce.dismiss

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/knitpkg-dev/knitpkg-mt
      name: KnitPkg on GitHub
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/knitpkg
      name: Follow us on X
    - icon: fontawesome/brands/discord
      link: https://discord.gg/bWvWpjw5m4
      name: Join our Discord

  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY

  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - 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
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - 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

plugins:
  - search:
      separator: '[\s\-,:!=|$$|()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

nav:
  - Overview: index.md
  - Installation: installation.md
  - Getting started: getting-started.md
  - Core Concepts:
    - concepts/overview.md
    - Manifest: concepts/manifest.md
    - KnitPkg Directives: concepts/directives.md
    - Install and Compile: concepts/install-and-compile.md
    - Build info: concepts/build-info.md
    - Include vs Flat Modes: concepts/include-vs-flat-modes.md
    - Projects vs Packages: concepts/projects-vs-packages.md
    - Composite Packages: concepts/composite-packages.md
    - Unit Tests: concepts/unit-tests.md
    - Registry: concepts/registry.md
    - Git First: concepts/git-first.md
    - Telemetry: concepts/telemetry.md
  - User Guide:
    - user-guide/overview.md
    - Creating Packages: user-guide/creating-packages.md
    - Managing Dependencies: user-guide/managing-dependencies.md
    - Unit Tests: user-guide/unit-tests.md
    - Local Dependencies: user-guide/local-dependencies.md
    - Registry: user-guide/registry.md
    - Revision: user-guide/revisions.md
    - Creating Projects: user-guide/creating-projects.md
    - Build Info: user-guide/build-info.md
    - Target Platforms: user-guide/target-platforms.md
    - Configuration: user-guide/configuration.md
  - Reference:
    - Manifest: reference/manifest.md
    - Version Ranges: reference/version-ranges.md
    - CLI Reference: reference/cli.md
#    - Glossary: reference/glossary.md
#    - Troubleshooting & FAQ: troubleshooting.md
#    - Contributing: contributing.md
  - Terms of Service:
    - Telemetry: terms-of-service/telemetry.md
    - Registry: terms-of-service/registry.md

copyright: >
  Copyright © 2024-2026 KnitPkg –
  <a href="#__consent">Change cookie settings</a>