leap-stc.github.io/mkdocs.yml at main · leap-stc/leap-stc.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

# Project Information
site_name: LEAP Technical Documentation
site_url: https://leap-stc.github.io/
site_author: LEAP Data and Compute Team
site_description: The home for all technical documentation related to LEAP and LEAP-Pangeo

# Repository Information
repo_name: leap-stc.github.io
repo_url: https://github.com/leap-stc/leap-stc.github.io
docs_dir: docs

nav:
  - "index.md"
  - Introduction:
      - Introduction: introduction/index.md
      - introduction/what_is_the_hub.md
      - introduction/getting_started.md

  - Data:
      - Data: data/index.md
      - File Formats: data/file_formats.md
      - Data Locations: data/data_locations.md
      - Data Lifecycle: data/data_lifecycle.md
      - Data Tools: data/data_tools.md
      - LEAP Data Catalog: data/data_catalog.md

  - Compute:
      - Computing: compute/index.md
      - Hub Access:
          - Overview: compute/hub_access.md
          - Access via Browser: compute/hub_browser_access.md
          - Access VSCode inside Hub: compute/vscode_inside_hub.md
          - Access via VSCode: compute/vs_code_to_hub.md
      - Dask Guide: compute/dask.md
      - compute/compute_scaling.md
      - compute/manage_software.md

  - Education:
      - Education: edu/index.md
      - edu/classes.md
      - edu/bootcamps.md
  - Reference:
      - Reference: reference/index.md
      - reference/authentication.md
      - reference/infrastructure_details.md

  - Support:
      - Contact: support/contact.md
      - FAQs:
        - support/signup_troubleshooting.md
        - support/hub_access_error.md
        - support/dask_killed_workers.md
        - support/hub_usage_alert.md


theme:
  language: en
  name: material
  logo: assets/LEAP_globe.png
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  font:
    text: Veranda
    code: Roboto Mono

  features:
    - content.code.annotate
    - content.code.copy
    - navigation.instant
    - navigation.tracking
    - navigation.tabs #displays top-level navigation items as tabs
    - navigation.tabs.sticky #makes the top-level tabs sticky when scrolling down
    - navigation.sections #groups top level sections in sidebar
    #- navigation.expand #expands all sub-sections by default
    - navigation.top #adds back-to-top button when scrolling down
    - navigation.indexes #enables section index pages
    - header.autohide
    - search.suggest
    - search.share
    #toc.integrate # enabling this causes the table of contents to be displayed in the left sidebar alongside navigation links

extra_css:
  - stylesheets/extra.css

extra:
  homepage: https://leap.columbia.edu/

plugins:
  - search
  - markdown-exec
  - autorefs

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - mkdocs-click
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

  - toc:
      permalink: true