modules/mkdocs.yml at master · sogeor/modules · 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
site_name: sogeor modules
site_description: OpenTofu modules and generators of the sogeor cluster constructor
repo_url: https://github.com/sogeor/modules
repo_name: sogeor/modules
edit_uri: edit/master/docs/
copyright: Copyright &copy; sogeor. Licensed under Apache-2.0.
strict: true

theme:
  name: material
  features:
    - content.code.copy
    - content.action.edit
    - navigation.sections
    - navigation.top
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Overview: index.md
  - Getting started: getting-started.md
  - Repository setup: setup.md
  - Configuration: configuration.md
  - Usage: usage.md
  - Operations: operations.md
  - Architecture: architecture.md
  - Security: security.md
  - Troubleshooting: troubleshooting.md
  - Decisions:
      - Overview: adr/index.md
      - "0001 Record architecture decisions": adr/0001-record-architecture-decisions.md
      - "0002 Repository layout": adr/0002-repository-layout.md
      - "0003 Cluster description validation": adr/0003-cluster-description-validation.md
      - "0004 Proxmox VE nodes": adr/0004-proxmox-nodes.md
      - "0005 Talos cluster": adr/0005-talos-cluster.md
      - "0006 Cluster API manifests": adr/0006-capi-manifests.md
      - "0007 Mesh registration": adr/0007-mesh-registration.md
      - "0008 Selectel prerequisites": adr/0008-selectel-capi-prerequisites.md