osipi.github.io/mkdocs.yml at master · OSIPI/osipi.github.io · 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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# Project information
site_name: OSIPI Documentation Hub
site_url: https://github.com/OSIPI/osipi.github.io
site_author: OSIPI
site_description: >-
  OSIPI aims to develop resources and best practices for the analysis of perfusion imaging data and interoperability of the analysis results.

# Repository
repo_name: OSIPI/osipi.github.io
repo_url: https://github.com/OSIPI/osipi.github.io

# Copyright
copyright: Copyright &copy; 2025 OSIPI

# Configuration
theme:
  name: material
  logo: assets/osipiImgs/OSIPI_logo.png
  favicon: assets/osipiImgs/OSIPI_logo_only_square.png
  custom_dir: docs/overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - multirepo:
      cleanup: false
  - open-in-new-tab

# Additional configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/OSIPI
    - icon: fontawesome/brands/slack
      link: https://app.slack.com/client/TFGVCE9HS

extra_css:
  - assets/stylesheets/extra.css
extra_javascript:
  - js/mathjax-config.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - codehilite
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

not_in_nav: |
  /tutorials/**/*.md

# Page tree
nav:
  - Home: index.md

  - Getting started:
      - Overview: getting-started.md

  - Lexicons:
      - Overview: lexicons.md
      - "(TF4.1) ASL Lexicon": https://osipi.github.io/ASL-Lexicon/
      - "(TF4.2) Caplex – Contrast-agent based perfusion MRI": "!import https://github.com/OSIPI/OSIPI_CAPLEX?branch=main&docs_dir=docs&multi_docs=True&config=mkdocs.yml&keep_docs_dir=true"

  - Python Code Repositories:
      - Overview: pyCode.md

      - "OSIPI Python package":
          - Documentation: https://osipi.github.io/osipy

      - "(TF2.2) ASL repository":
          - Documentation: https://github.com/OSIPI/TF2.2_OSIPI-ASL-toolbox/blob/main/ASL_functionalities_test_report_Github.docx
      - "(TF2.3) DCE/DSC repository":
          - Documentation: https://osipi.github.io/DCE-DSC-MRI_CodeCollection/
        # DCE-DSC-MRI_CodeCollection github pages is currently not setup - once setup, this will redirect to that page
      - "(TF2.4) IVIM repository":
          - Documentation: https://osipi.github.io/TF2.4_IVIM-MRI_CodeCollection/

  - Tools:
      - Overview: tools.md
      - "ASL parameter generator": https://github.com/OSIPI/asl-parameter-reporter
      - "Artefact database": https://github.com/OSIPI/perfusion-artifacts