forked from ultralytics/ultralytics
-
Notifications
You must be signed in to change notification settings - Fork 19
/
mkdocs.yml
106 lines (95 loc) 路 2.44 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
site_name: Ultralytics YOLOv8 Docs
repo_url: https://github.com/ultralytics/ultralytics
edit_uri: https://github.com/ultralytics/ultralytics/tree/main/docs
repo_name: ultralytics/ultralytics
theme:
name: "material"
logo: https://github.com/ultralytics/assets/raw/main/logo/Ultralytics-logomark-white.png
favicon: https://github.com/ultralytics/assets/raw/main/logo/favicon-yolo.ico
font:
text: Roboto
palette:
# Palette toggle for light mode
- scheme: default
# primary: grey
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
# primary: black
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.action.edit
- content.code.annotate
- content.tooltips
- search.highlight
- search.share
- search.suggest
- toc.follow
- navigation.top
- navigation.expand
- navigation.footer
- content.tabs.link # all code tabs change simultaneously
# Version drop-down menu
# extra:
# version:
# provider: mike
extra_css:
- stylesheets/style.css
markdown_extensions:
# Div text decorators
- admonition
- pymdownx.details
- pymdownx.superfences
- tables
- attr_list
- def_list
# Syntax highlight
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
# Button
- attr_list
# Content tabs
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
# Highlight
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
plugins:
- mkdocstrings
- search
# Primary navigation
nav:
- Home: index.md
- Quickstart: quickstart.md
- Tasks:
- Detection: tasks/detection.md
- Segmentation: tasks/segmentation.md
- Classification: tasks/classification.md
- Usage:
- CLI: cli.md
- Python: python.md
- Predict: predict.md
- Configuration: cfg.md
- Customization Guide: engine.md
- Ultralytics HUB: hub.md
- iOS and Android App: app.md
- Reference:
- Engine:
- Model: reference/model.md
- Trainer: reference/base_trainer.md
- Validator: reference/base_val.md
- Predictor: reference/base_pred.md
- Exporter: reference/exporter.md
- Results: reference/results.md
- ultralytics.nn: reference/nn.md
- Operations: reference/ops.md