-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
129 lines (119 loc) · 2.93 KB
/
mkdocs.yml
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
site_name: ESIIL OASIS
site_description: ESIIL OASIS Documentation
site_author: ESIIL CI team
site_url: https://cu-esiil.github.io/documentation/
# Repository
repo_name: documentation
repo_url: https://github.com/cu-esiil/documentation
edit_uri: edit/main/docs/
# Copyright
copyright: 'Copyright © 2022 - 2023 University of Colorado Boulder'
# Page tree
nav:
- Main:
- Home: index.md
- Status and News: status.md
- Governance: governance.md
- Frequently Asked Questions:
- General FAQs: faq.md
- Troubleshooting: troubleshooting.md
- Allocations: allocations.md
- Security: security.md
- General:
- Resources: resources.md
- Storage: storage.md
- Infrastructure:
- OASIS: oasis.md
- CyVerse: cyverse.md
- Jetstream-2: js2.md
- Software:
- Docker: docker.md
- ImgSPEC: imgspec.md
- Jupyter Lab: jupyter.md
- Jupyter Hub: jupyter_hub.md
- RStudio: rstudio.md
- Kubernetes: k8s.md
- Policies:
- Acceptable Use: acceptable_use.md
- Best Practices: best_practice.md
# Configuration
theme:
name: 'material'
# 404 page
static_templates:
- 404.html
# downloading ipynb notebooks
custom_dir: "docs/overrides"
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
font:
text: Montserrat
code: Regular
favicon: assets/favicon.png
icon:
logo: material/cloud-tags
# Options
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/cu-esiil/documentation.git
# 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
plugins:
- search
- mkdocstrings
- git-revision-date
- mkdocs-jupyter:
include_source: True
ignore_h1_titles: True
execute: True
execute_ignore: "notebooks/*.ipynb"