Exact/mkdocs.yml at master · DeepMicroscopy/Exact · 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
site_name: ' '
site_description: EXpert Algorithm Collaboration Tool — collaborative image annotation platform
site_url: https://deepmicroscopy.github.io/Exact/
repo_url: https://github.com/DeepMicroscopy/Exact
repo_name: DeepMicroscopy/Exact
edit_uri: edit/master/docs/
copyright: Copyright &copy; 2021–2026 DeepMicroscopy · MIT License

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/icon.svg
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.instant
    - search.highlight
    - search.share
    - content.code.copy
    - content.tabs.link
    - toc.follow
  font:
    text: Inter
    code: JetBrains Mono

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DeepMicroscopy/Exact
      name: EXACT on GitHub
    - icon: fontawesome/solid/newspaper
      link: https://doi.org/10.1038/s41598-021-83827-4
      name: Scientific Reports paper
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/EXACT-Sync/
      name: EXACT-Sync on PyPI

plugins:
  - search
  - swagger-ui-tag

hooks:
  - docs/hooks.py

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.inlinehilite
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - User Guide:
    - Core Concepts: user-guide/concepts.md
    - Annotation Workflow: user-guide/annotation-workflow.md
    - Image Formats: user-guide/image-formats.md
    - Keyboard Shortcuts: user-guide/keyboard-shortcuts.md
  - Developer Guide:
    - Architecture: developer-guide/architecture.md
    - Adding Image Formats: developer-guide/adding-image-formats.md
    - Plugin System: developer-guide/plugins.md
    - Frontend: developer-guide/frontend.md
  - API Reference: api/index.md
  - What's New: whats-new.md