kjournal/mkdocs.yaml at main · raffis/kjournal · 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
site_name: kjournal
site_url: https://raffis.githubpages.io/kjournal
site_description:
copyright:
repo_name: raffis/kjournal
repo_url: https://github.com/raffis/kjournal
edit_uri: edit/main/docs

theme:
  name: material
  language: en
  include_search_page: false
  search_index_only: true
  palette:
    - media: "(prefers-color-scheme: light)"  # Light mode
      scheme: default
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
    - media: "(prefers-color-scheme: dark)"  # Dark mode
      scheme: slate
      primary: light blue
      accent: indigo
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
  features:
    - search.suggest
    - search.highlight
    - search.share

plugins:
  - search
  - minify:
      minify_html: true

markdown_extensions:
  - tables
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - codehilite
  - meta
  - toc:
      permalink: true
  - pymdownx.tasklist:
      custom_checkbox: true

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/goreleaser

nav:
- Home: index.md
- quick-start.md
- how-it-works.md
- goals.md
- Prerequisites:
  - prerequisites/ship.md
  - prerequisites/audit.md
  - prerequisites/event-exporter.md
- Server:
  - server/install.md
  - server/config.md
  - server/uninstall.md
  - Methods:
    - server/methods/helm.md
  - Storage:
    - server/storage/elasticsearch.md
    - server/storage/other.md
  - Command Line Usage:
      - server/cmdref/kjournal-apiserver.md
- CLI:
  - cli/install.md
  - Command Line Usage:
      - cli/cmdref/kjournal.md
      - cli/cmdref/kjournal_audit.md
      - cli/cmdref/kjournal_clusteraudit.md
      - cli/cmdref/kjournal_diary.md
      - cli/cmdref/kjournal_version.md
- Tutorials:
  - tutorials/kind.md
- API:
  - api/config.kjournal.v1alpha1.md
  - api/core.kjournal.v1alpha1.md
- Development:
  - development/CONTRIBUTING.md
  - development/CODE_OF_CONDUCT.md