architecture/mkdocs.yml at main · SciLifeLab/architecture · 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
site_name: SciLifeLab Architecture
site_url: https://scilifelab.github.io/architecture/
site_description: Architecture decisions and guidelines for SciLifeLab infrastructure
site_author: SciLifeLab Architecture Board

repo_name: scilifelab/architecture
repo_url: https://github.com/scilifelab/architecture

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  font:
    text: Open Sans
    code: Fira Code
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: lime
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: lime
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - tables
  - attr_list
  - toc:
      permalink: true

plugins:
  - search

nav:
  - Home: index.md
  - Architecture Decisions:
      - decisions/0001-record-architecture-decisions.md
      - decisions/0002-use-cc-by-sa-4-0-license.md
      - decisions/0003-use-single-process-approach-for-architecture-requests.md
      - decisions/0004-use-mkdocs-material-for-documentation-site.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SciLifeLab
    - icon: fontawesome/solid/globe
      link: https://scilifelab.se
  generator: false
  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
    cookies:
      github:
        name: GitHub
        checked: true

copyright: >-
  Licensed under
  <a href="https://creativecommons.org/licenses/by-sa/4.0/" target="_blank" rel="noopener">CC BY-SA 4.0</a>
  by SciLifeLab