k8tre/mkdocs.yml at main · eggai-tech/k8tre · 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
site_name: K8TRE
site_description: SATRE-Compliant TRE implementation on Kubernetes
site_author: K8TRE Team
repo_url: https://github.com/k8tre/k8tre
repo_name: k8tre/k8tre

theme:
  name: material
  logo: img/logo.jpeg
  palette:
    - scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - content.code.copy
    - content.tabs.link

plugins:
  - search
  - macros
extra_css:
  - css/colour-blocks.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - footnotes
  # - pymdownx.emoji:
  #     emoji_index: !!python/name:materialx.emoji.twemoji
  #     emoji_generator: !!python/name:materialx.emoji.to_svg

nav:
  - Home: index.md
  - Specification:
      - Introduction: spec/README.md
      - Glossary: spec/glossary.md
      - The K8TRE Specification:
        #  - Asset Management : spec/assetmanagement.md
          - BYO Software : spec/byosoftware.md
          - Container Runtimes : spec/containerruntimes.md
          - Databases : spec/database.md
          - DNS : spec/dns.md
          - Documentation : spec/documentation.md
        #  - Egress : spec/egress.md
          - GitOps : spec/gitops.md
          - Identity: spec/identity.md
          - Ingress : spec/ingress.md
          - Networking : spec/networking.md
        #  - Resources : spec/resources.md
          - Secrets : spec/secrets.md
          - Storage : spec/storage.md
          - Workspace Isolation: spec/workspaces.md
  - Implementation:
      - Infrastructure: implementation/architecture.md
      - ArgoCD: implementation/argocd.md
      - Agnostics: implementation/agnostics.md
      - Applications: implementation/applications.md
      - Network Policy: implementation/network-policy.md
  # - Deployment:
  #     - Installation: deployment/installation.md
  - Development:
      - Introduction: development/introduction.md
      - K3S Single-Cluster Setup: development/k3s-dev.md
      - K3S Multi-Cluster Setup: development/k3s.md
      - Application Development: development/developer-guide.md
  - Guides:
      - Installation: guides/installation.md
      - Workspace Access: guides/workspace-access.md
  - Contributing: contributing.md