adit/mkdocs.yml at main · openradx/adit · 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: ADIT Documentation
site_description: Automated DICOM Transfer - A Swiss army knife to exchange DICOM data between various systems
site_author: CCI Bonn
site_url: https://openradx.github.io/adit

repo_name: openradx/adit
repo_url: https://github.com/openradx/adit
edit_uri: edit/main/docs/

hooks:
  - docs/hooks/copyright.py

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: green
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - toc.follow

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      preserve_tabs: true
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - User Documentation:
      - Admin Guide: user-docs/admin-guide.md
      - User Guide: user-docs/user-guide.md
      - Technical Overview: user-docs/technical-overview.md
      - Features: user-docs/features.md
      - FAQ: user-docs/faq.md
  - Developer Documentation:
      - Contributing: dev-docs/contributing.md
      - Architecture: dev-docs/architecture.md
      - Core Components: dev-docs/core_components.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/openradx/adit
    - icon: fontawesome/solid/globe
      link: https://ccibonn.ai/

extra_javascript:
  - assets/js/slideshow.js
  - assets/js/mermaid-zoom.js

extra_css:
  - assets/css/slideshow.css
  - assets/css/mermaid-enhancements.css