mkdocs.yml

site_name: Useful python (ufpy)
site_url: https://honey-team.github.io/ufpy/

repo_url: https://github.com/honey-team/ufpy
repo_name: honey-team/ufpy

theme:
  name: material
  logo: assets/images/logo.png
  features:
    - content.code.copy
    - content.tooltips
    - content.code.annotate
    - search.suggest
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - navigation.instant
    - navigation.instant.progress
    - toc.follow
  icon:
    repo: fontawesome/brands/github
    annotation: material/plus-circle
    tag:
      typec: material/code-braces
      info: octicons/info-16
      useful: simple/python
      ustl: material/language-cpp
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra:
  tags:
    type check: typec
    information: info
    useful class: useful
    useful feature: useful
    uSTL: ustl
  version:
    provider: mike

plugins:
  - search
  - tags
  - social

markdown_extensions:
  - abbr
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
  - markdown_include.include:
      base_path: .
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg