foss/mkdocs.yml at mkdocs · CyVerse-learning-materials/foss · 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
docs_dir: docs/
repo_name: 'CyVerse-learning-materials/foss'
repo_url: 'https://github.com/CyVerse-learning-materials/foss'

site_name: 'CyVerse Foundational Open Science Skills 2025'
site_description: 'Workshop teaching researchers core skills for conducting open science.'
site_author: 'CyVerse Science Team'
site_url: 'https://foss.cyverse.org'

edit_uri: edit/mkdocs/docs

# Copyright
copyright: 'Copyright &copy; 2025 CyVerse'

# Navigation Page

nav:
  - Home:
    - 'Home': index.md
    - 'Before FOSS Starts': installation.md
    - 'Schedule': schedule.md
    - 'Code of Conduct': code_of_conduct.md
    - 'Glossary & Acronyms': glossary.md
  - Lessons:
    - '1. Open Science': 01_intro_open_sci.md
    - '2. Data Management & Documentation': 02_managing_data.md
    - '3. How to Talk to Computers': 03_talk_to_computer.md
    - '4. How to Talk to LLMs': 04_talk_to_llms.md
    - '5. Reproducibility I: Version Control': 05_version_control.md
    - '6. Reproducibility II Software Environments': 06_soft_env.md
    - '7. Reproducibility III: Containers': 07_containers.md
    - '8. Remote Computing: HPC': 09_HPC.md
    - '9. Remote Computing: Cyverse': 08_remote_computing_cyverse.md
    - '10. AI Models & Where to Find Them': https://tyson-swetnam.github.io/intro-gpt/agenda/#about

  - Capstone Project:
      - 'Overview': final_project/overview.md

# must also set Action to use `@nomaterial` branch instead of `@master` for material
theme:
  name: material
# setting features for the navigation tab
  features:
    - navigation.instant
      #- navigation.expand
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - toc.follow
  # Default values, taken from mkdocs_theme.yml
  language: en
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: Roboto
    code: Regular
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
  favicon: 'assets/favicon.ico'
  logo: 'assets/android-chrome-512x512.png'

# Options
extra:
  social:
    - icon: fontawesome/brands/orcid
      link: https://orcid.org/
    - icon: fontawesome/brands/github
      link: https://github.com/cyverse-learning-material/
    - 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: UA-72224033-6

# Custom CSS and JavaScript for chatbot
extra_css:
  - stylesheets/extra.css
  - chatbot_widget.css

extra_javascript:
  - chatbot_widget.js

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
      title: On this page
  - 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

plugins:
    - search
    - mkdocstrings
    - git-revision-date
    - mkdocs-jupyter:
          include_source: True
          ignore_h1_titles: True