Segmentation_Annotation_Studio/mkdocs.yml at main · mlexchange/Segmentation_Annotation_Studio · 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
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
site_name: Segmentation Annotation Studio
site_description: >-
  User guide for the Segmentation Annotation Studio — install the tool, annotate
  images, and export COCO datasets for SAM3 fine-tuning.
site_author: ALS Computing
docs_dir: docs
use_directory_urls: true

theme:
  name: material
  language: en
  logo: assets/logo.png
  favicon: assets/logo.png
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/git-alt
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - search.suggest
    - search.highlight
  palette:
    # Light mode — Finch sky palette
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode — Finch deep-sky palette
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra_css:
  - stylesheets/finch.css

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Getting started:
      - Installation: getting-started/installation.md
      - Quick start: getting-started/quick-start.md
  - Using the tool:
      - Overview: guide/index.md
      - 1. Connect to data: guide/connect.md
      - 2. Browse & select: guide/browse.md
      - 3. Annotate: guide/annotate.md
      - 4. Annotation guide: guide/reference-guide.md
      - 5. Export & download: guide/export.md
  - Reference:
      - Software architecture: reference/architecture.md
      - Keyboard shortcuts: reference/shortcuts.md
      - Troubleshooting: reference/troubleshooting.md

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/