User-Manuals/mkdocs.yml at mkdocs-material · ua-data7/User-Manuals · 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
docs_dir: docs/
site_name: Soteria User Manuals
site_url: https://ua-data7.github.io/user-manuals
site_description: Soteria User Documentation
site_author: 'Soteria CyVerse Health'

# uncomment to show the github icon in the header with
# number of forks & stars
repo_url: https://github.com/ua-data7/user-manuals
edit_uri: edit/mkdocs-material/docs

# Copyright
copyright: 'Copyright &copy; 2024 University of Arizona Data Science Institute, Arizona Board of Regents'

# Navigation Pane

nav:
  - Soteria Documentation Home:
    - index.md
  - Logging in & Access Guides:
    - access/index.md
    - Obtaining Soteria Access via VPN: access/access_vpn.md
    # - Accessing Soteria via macOS: access/access_mac.md
    # - Accessing Soteria via Windows: access/access_win.md
    - Soteria and the UArizona HPC System: access/access_hpc.md
  - Data Transfer & Management:
    - data_transfer/index.md
    - Globus Data Transfer: data_transfer/Globus.md
  - Training Modules & Tutorials:
    - usage_guides/index.md
    - CyVerse Health User Manual: usage_guides/CyVerse_Health.md
    - Posit Connect Health Tutorial : https://ua-data7.github.io/rsconnect-tutorial/

# JavaScript for Intercom Widget
extra_javascript:
  - javascripts/intercom.js

# logos
imgwidth: 7px;
theme:
  highlightjs: true
  name: material
  font:
    text: 'Open Sans'
    code: 'Roboto Mono'
  logo: 'assets/uarizona.png'
  favicon: 'assets/favicon-ua.ico'
# setting features for the navigation tab
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
    - toc.integrate
    - toc.follow
  # Default values, taken from mkdocs_theme.yml
  language: en
  palette:
    - media: "main"
      primary: 'white'

# Customization
extra:
  social:
    - icon: fontawesome/brands/orcid
      link: https://orcid.org/
    - icon: fontawesome/brands/github
      link: https://github.com/cyverse/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/cyverseorg
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/cyverse.org
    - icon: fontawesome/brands/docker
      link: https://harbor.cyverse.org/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/c/CyverseOrgProject
  analytics:
    provider: google
    property: G-6WMK2Y07YW

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra_css:
  - stylesheets/custom.css