DatasetAnnotationTool/mkdocs.yml at main · OpenSportsLab/DatasetAnnotationTool · GitHub

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
site_name: OSL Action Spotting Annotation Tool
site_description: A GUI tool for annotating action spotting datasets in sports video (OpenSportsLab)
site_author: OpenSportsLab
repo_url: https://github.com/OpenSportsLab/DatasetAnnotationTool
repo_name: OpenSportsLab/DatasetAnnotationTool

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

# Optional: logo and favicon if you have them
# logo: assets/logo.png
# favicon: assets/favicon.ico

nav:
  - Home: index.md
  - Installation: installation.md
  - Getting Started: getting_started.md
  - User Guide:
      - Overview: gui_overview.md
      - Annotating:
          - Annotating Actions: annotating.md
          - Editing Annotations: editing.md
          - Saving & Loading: saving_loading.md
          - Keyboard Shortcuts: shortcuts.md
      - Batch Tools: batch_tools.md
  - Troubleshooting: troubleshooting.md
  - FAQ: faq.md
  - About: about.md
  - Contributing: contributing.md  # (add this file if you want contributions)
  - Changelog: changelog.md        # (add this file if you want to track changes)

# Optional: Add Markdown extensions
markdown_extensions:
  - admonition
  - codehilite
  - toc:
      permalink: true
  - footnotes
  - tables
  - pymdownx.superfences


# Optional: If you want to deploy on GitHub Pages
plugins:
  - search
#  - git-revision-date
#  - minify:
#      minify_html: true