mkdocs.yml

site_name: AFF3CT-core Documentation
site_url: https://aff3ct.github.io/aff3ct-core/
theme:
  logo: assets/diagram-project-solid.svg
  features:
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - navigation.footer
  name: material
  palette:
    scheme: default
    primary: black
    secondary: black
    hljs_style: monokai

  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

  language: en

repo_url: https://github.com/aff3ct/aff3ct-core

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets :
      auto_append:
        - docs/abbreviations.md
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - abbr

plugins: 
  - search

extra_css:
  - css/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: 
    - index.md
  - For Users:
    - Tests:
      - tests_bootstrap.md
    - Runtime:
      - thread_pinning.md
  - For Developers:
      - Basic Components:
        - task.md
        - module.md
        - socket.md
        - sequence.md
        - pipeline.md
        - switcher.md
      - New Features and Discussions:
        - socket_fwd.md
        - pipeline_ctrl_flow.md
        - wip.md