docker-for-science/mkdocs.yml at main · queeniewhw/docker-for-science · 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
site_name: Docker for AI in Science
repo_url: https://github.com/acceleratescience/docker-for-science
site_url: https://acceleratescience.github.io/docker-for-science/
nav:
  - Home:
    - Welcome!: index.md
    - License: Home/LICENSE.md
    - About us: Home/about.md
  - Reproducibility: reproducibility.md
  - Basics:
    - Hello World!: Basics/hello-world.md
    - Volumes: Basics/volumes.md
    - Docker Hub: Basics/docker-hub.md
  - Building your own images:
    - Building your own images: Building-your-own-images/index.md
    - Hello World!: Building-your-own-images/hello-world.md
    - Dockerfile: Building-your-own-images/dockerfiles.md
    - Docker Repositories: Building-your-own-images/dockerhub.md
  - Devcontainers: devcontainers.md
    # - Docker Compose: Building-your-own-images/docker-compose.md
  # - Hello World!: hello-world.md
  # - Multi Page 1:
  #   - Subpage 1: multi_1/subpage_1.md
  #   - Subpage 2: multi_1/subpage_2.md
  # - Introduction to Docker:
  #   - intro/index.md
  #   - Why Docker?: intro/why.md
  #   - Docker Basics: intro/introdocker.md
  # - Resources:
  #   - resources/index.md
  #   - Slides: resources/slides.md
  #   - Further reading: resources/references.md
theme:
  favicon: imgs/trace.svg
  name: material
  logo: ./imgs/trace.svg
  features:
    - search.suggest
    - search.highlight
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  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
  icon:
    annotation: material/chevron-right-circle
plugins:
  - mkdocstrings
  - search
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
extra:
  homepage: https://docs.science.ai.cam.ac.uk/
  consent:
      title: Cookie consent
      description: >-
        We use cookies to recognize your repeated visits and preferences, as well
        as to measure the effectiveness of our documentation and whether users
        find what they're searching for. With your consent, you're helping us to
        make our documentation better.
      actions:
        - accept
        - reject
        - manage
  analytics:
    provider: google
    property: G-JLGLYJ24SD
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/acceleratescience/REPO-TITLE/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form</a>.
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/acceleratescience/REPO-TITLE/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form</a>.
copyright: >
  Copyright &copy; 2024 Accelerate Programme for Scientific Discovery –
  <a href="#__consent">Change cookie settings</a>
dev_addr: '0.0.0.0:8080'
watch:
  - .