mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Ossum Technologies
site_url: https://ossum.tech/
copyright: >
  Copyright © 2019-2025 Ossum Inc. -
  <a href="#__consent">Change cookie settings</a>
theme:
  name: material
  custom_dir: overrides
  logo: assets/images/ossum_logo_and_name-01.png
  favicon: assets/images/favicon.png
  font:
    text: Encode Sans
    code: Roboto Mono
  features:
    - announce.dismiss
    - content.tooltips
    - header.autohide
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - search.suggest
    - search.share
    - search.highlight
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

extra:
  analytics:
    provider: google
    property: G-97Q04B6XCX
  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.
    cookies:
      analytics: GA_ossum_tech
      github: GH_ossum_tech
    consent:
      actions:
        - accept
        - reject
        - manage
  social:
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/ossum-inc/
    - icon: fontawesome/brands/github
      link: https://www.github.com/ossuminc
  generator: false

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

    # Python Markdown Extensions
  - 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
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde