Files
uniface/mkdocs.yml

86 lines
2.3 KiB
YAML

site_name: uniface
site_url: https://yakhyo.github.io/uniface/
site_author: Yakhyokhuja Valikhujaev
site_description: "UniFace: A Comprehensive Library for Face Detection, Recognition, Landmark Analysis, Age, and Gender Detection"
repo_url: https://github.com/yakhyo/uniface
repo_name: yakhyo/uniface
theme:
name: material
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
- content.code.expand
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/lightbulb
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/lightbulb-off-outline
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
favicon: assets/favicon.png
icon:
logo: logo
nav:
- Home: index.md
- Overview: overview.md
- Installation: installation.md
- Usage: usage.md
- Models:
- Face Detection: models/detection.md
- Face Recognition: models/recognition.md
- Landmark Detection: models/landmarks.md
- Age & Gender Estimation: models/age_gender.md
- Gaze Estimation: models/gaze.md
- Tutorials:
- Quickstart: tutorials/quickstart.md
- App Integration: tutorials/integration.md
- Performance Tips: tutorials/performance.md
- API Reference:
- Detection: reference/detection.md
- Recognition: reference/recognition.md
- About:
- Changelog: about/changelog.md
- License: about/license.md
- Code of Conduct: about/conduct.md
plugins:
- blog
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
- mkdocstrings:
default_handler: python