uniface/mkdocs.yml

site_name: UniFace
site_description: A Unified Face Analysis Library for Python
site_author: Yakhyokhuja Valikhujaev
site_url: https://yakhyo.github.io/uniface

repo_name: yakhyo/uniface
repo_url: https://github.com/yakhyo/uniface
edit_uri: edit/main/docs/

copyright: Copyright © 2025 Yakhyokhuja Valikhujaev

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.tabs
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.tabs.link
    - announce.dismiss
    - toc.follow

  icon:
    logo: material/book-open-page-variant
    repo: fontawesome/brands/git-alt
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/yakhyo
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/uniface/
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/y_valikhujaev
  analytics:
    provider: google
    property: G-FGEHR2K5ZE

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - footnotes
  - attr_list
  - md_in_html
  - def_list
  - tables
  - toc:
      permalink: false
      toc_depth: 3
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.tilde

plugins:
  - search
  - git-committers:
      repository: yakhyo/uniface
      branch: main
      token: !ENV MKDOCS_GIT_COMMITTERS_APIKEY
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quickstart: quickstart.md
      - Notebooks: notebooks.md
      - Model Zoo: models.md
      - Datasets: datasets.md
  - Tutorials:
      - Image Pipeline: recipes/image-pipeline.md
      - Video & Webcam: recipes/video-webcam.md
      - Face Search: recipes/face-search.md
      - Batch Processing: recipes/batch-processing.md
      - Anonymize Stream: recipes/anonymize-stream.md
      - Custom Models: recipes/custom-models.md
  - API Reference:
      - Detection: modules/detection.md
      - Recognition: modules/recognition.md
      - Tracking: modules/tracking.md
      - Landmarks: modules/landmarks.md
      - Attributes: modules/attributes.md
      - Parsing: modules/parsing.md
      - Matting: modules/matting.md
      - Gaze: modules/gaze.md
      - Head Pose: modules/headpose.md
      - Anti-Spoofing: modules/spoofing.md
      - Privacy: modules/privacy.md
      - Stores: modules/stores.md
  - Guides:
      - Overview: concepts/overview.md
      - Inputs & Outputs: concepts/inputs-outputs.md
      - Coordinate Systems: concepts/coordinate-systems.md
      - Execution Providers: concepts/execution-providers.md
      - Model Cache: concepts/model-cache-offline.md
      - Thresholds: concepts/thresholds-calibration.md
  - Resources:
      - Contributing: contributing.md
      - License: license-attribution.md
      - Releases: https://github.com/yakhyo/uniface/releases
      - Discussions: https://github.com/yakhyo/uniface/discussions