mkdocs.yml

site_name: TSGECO Documentation
site_url: https://tsgeco.github.io/
repo_url: https://github.com/TSGECO/TSGECO.github.io
repo_name: TSGECO/TSGECO.github.io
site_description: Documentation for the TSG (Transcript Segment Graph) ecosystem
site_author: TSGECO Team
copyright: Copyright © 2025 TSGECO Team

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.footer
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.highlight
    - search.suggest
    - search.share
    - toc.follow
    - toc.integrate
  logo: images/tsgeco.png
  favicon: images/tsgeco.png
  icon:
    repo: fontawesome/brands/github

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
      - Overview: getting-started/index.md
      - Installation: getting-started/installation.md
      - Quick Start Guide: getting-started/quickstart.md
  - User Guide:
      - Overview: user-guide/index.md
      - Basic Usage: user-guide/basic-usage.md
      - Advanced Features: user-guide/advanced-features.md
  - API Reference:
      - Overview: api-reference/index.md
  - Community: community.md

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - codehilite
  - footnotes
  - meta
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - 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.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
  - toc:
      permalink: true
      title: On this page

plugins:
  - search
  - minify:
      minify_html: true
  - git-revision-date-localized:
      type: date
      enable_creation_date: true
      fallback_to_build_date: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
  - tags

# Extra CSS and JavaScript
extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/TSGECO
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/TSGECO
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/tsgeco
    - icon: fontawesome/solid/envelope
      link: mailto:info@tsgeco.org

  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.