training-intro-to-snakemake/mkdocs.yml at main · kir-rescomp/training-intro-to-snakemake · 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
site_name: Introduction to Snakemake
site_author: The Kennedy Institute of Rheumatology, NDORMS, University of Oxford
site_dir: public
site_url: "https://kir-rescomp.github.io/training-intro-to-snakemake/"

#Repository information
repo_name:  kir-rescomp/training-intro-to-snakemake
repo_url: https://github.com/kir-rescomp/training-intro-to-snakemake


theme:
  name: material
  logo: images/KIR_Research_Computing_Hub_layered_logo_favicon.svg
  favicon: images/kir_standalone_logo.png
   # 404 page
  static_templates:
    - 404.html

  palette:

  # Palette toggle for automatic mode
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
    primary: custom

  # Palette toggle for light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: custom


    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
    primary: custom

  features:
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate


  # Necessary for search to work properly
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  font:
    text: Mukta
    code: Fira Code

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - 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:
      alternate_style: true
  - pymdownx.tasklist:
      clickable_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets
  - pymdownx.blocks.caption

plugins:
  - glightbox:
      effect: zoom
      zoomable: true
  - search:
      lang: en

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

copyright : KIR Training Catalogue is licensed under a <a rel="noopener" target="_blank" href="https://www.gnu.org/licenses/gpl-3.0.en.html">GNU General Public License v3.0</a>


extra_css:
  - stylesheets/extra.css
  - stylesheets/catalogue-return-button.css
  - stylesheets/code_block.css
  - stylesheets/code_block_colour_dracula.css
  - stylesheets/code_block_colour_monokai.css
  - stylesheets/code_block_colour_github_dark.css
  - stylesheets/code_block_colour_nord.css
  - stylesheets/code_block_colour_onedark.css
  - stylesheets/side_bar_menu.css
  - stylesheets/snakefile.css