software-architecture-documentation-template/mkdocs.yml at main · dassiorleando/software-architecture-documentation-template · 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
site_name: Software Architecture
site_url: https://dassiorleando.github.io/software-architecture-documentation-template
copyright: MIT
theme:
  name: mkdocs-material-adr
  features:
    - toc.follow
    - navigation.footer
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.instant
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      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 Light mode
extra_css:
  - css/custom.css
extra_javascript:
  - js/custom.js
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - 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
nav:
  - Getting Started:
    - index.md
    - introduction-and-goals.md
    - architecture-constraints.md
    - context-scope.md
    - solution-strategy.md
    - building-block-view.md
    - runtime-view.md
    - deployment-view.md
    - cross-cutting-concepts.md
    - Decision Records: decisions/0000-index.md
    - quality-requirements.md
    - risks-technical-debts.md
    - glossary.md
  - Architecture Decisions:
    - decisions/0000-index.md
    - decisions/0001-sample.md
plugins:
  - search
  - mkdocs-material-adr/adr
  - macros:
      modules:
        - mkdocs_macros_adr_summary