mkdocs-dsh-docs/mkdocs.yml at main · UCL-ARC/mkdocs-dsh-docs · 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
site_name: Data Safe Haven Research Compute Services Documentation
site_description: Documentation for using the DSH HPC Cluster and related services
site_url: https://github-pages.arc.ucl.ac.uk/mkdocs-dsh-docs/

# Associated Git Repo Config
repo_name: UCL-ARC/mkdocs-dsh-docs
repo_url: https://github.com/UCL-ARC/mkdocs-dsh-docs

# If this is removed, the edit buttons will go away. I like them.
edit_uri: blob/master/mkdocs-project-dir/docs/

theme:
  name: material
  logo: images/ucl-logo.png
  custom_dir: overrides
  icon:
    previous: fontawesome/solid/angle-left
    next: fontawesome/solid/angle-right
    repo: fontawesome/brands/github
  features:
    - navigation.sections
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.expand
    - navigation.top
    - navigation.path
    - navigation.indexes
    - navigation.footer
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - repository
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/eye
        name: Switch to dark mode
      primary: custom
      accent: pink
    - scheme: slate
      toggle:
        icon: material/eye-outline
        name: Switch to light mode
      primary: custom
      accent: pink
extra:
  homepage: https://www.ucl.ac.uk
  social:
    - icon: fontawesome/brands/github   # <-- FIXED: now a list item
      link: https://github.com/UCL-ARC/mkdocs-dsh-docs
  consent:
      github:
      actions:
        - reject
        - manage
        - accept
      title: Local storage notification
      description: >-
        We don't use cookies at all, but we do use your browser's local
        storage to remember whether you prefer dark or light mode, and
        to store the GitHub statistics displayed in the top-right.
        You can disable the stats retrieval to GitHub and associated storage here.
extra_css:
  - 'stylesheets/style.css'
markdown_extensions:
  - admonition
  - footnotes
  - attr_list
plugins:
  - search
  - awesome-nav:
      strict: false
      collapse_single_pages: true
      title_case: true
      ignore_files:
        - 'index.md'
copyright: Copyright &copy; 2025 Bespoke Solutions Teams, UCL