timoni/mkdocs.yml at main · MarcelusBrowni/timoni · 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
site_name: Timoni
site_description: |
  Timoni is a package manager for Kubernetes powered by CUE lang.
site_author: Stefan Prodan
site_url: https://timoni.sh
repo_name: stefanprodan/timoni
repo_url: https://github.com/stefanprodan/timoni
edit_uri: ""
copyright: Copyright © 2023 Stefan Prodan

home:
  image: images/logo_icons.svg
  tagline: Distribution and Lifecycle Management for Cloud-Native Applications
  description: |
    Timoni brings CUE's type safety, code generation, and data validation features to Kubernetes,
    making the experience of crafting complex deployments into a pleasant journey.
  features: true

theme:
  name: material
  logo: images/logo_indigo.svg
  favicon: images/favicon.png
  language: en
  custom_dir: docs/theme/
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.sections
    - navigation.top
    - navigation.tabs

extra:
  social:
    - icon: fontawesome/brands/slack
      link: https://cloud-native.slack.com/team/ULPRMFH38
    - icon: fontawesome/brands/square-x-twitter
      link: https://x.com/stefanprodan
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/stefanprodan

docs_dir: docs

plugins:
  - search
  - redirects:
      redirect_maps:
        'module-semver.md': 'module-distribution.md'
        'bundles.md': 'bundle.md'
        'values.md': 'bundle.md'

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - meta
  - codehilite
  - pymdownx.tilde
  - pymdownx.progressbar
  - pymdownx.tasklist
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Documentation:
    - Quickstart: quickstart.md
    - Concepts: concepts.md
    - Installation: install.md
    - Compared to other tools: comparison.md
    - App Delivery:
        - Bundle files: bundle.md
        - Bundle runtime: bundle-runtime.md
        - Bundle distribution: bundle-distribution.md
        - Bundle secrets injection: bundle-secrets.md
    - Module Development:
        - Module structure: module.md
        - Module distribution: module-distribution.md
        - Module signing: module-sign.md
    - Automation:
        - GitHub Actions: github-actions.md
        - GitOps with Flux: gitops-flux.md
  - CLI Reference:
      - cmd/timoni.md
      - cmd/timoni_version.md
      - Instance:
          - cmd/timoni_apply.md
          - cmd/timoni_build.md
          - cmd/timoni_delete.md
          - cmd/timoni_list.md
          - cmd/timoni_inspect.md
          - cmd/timoni_inspect_module.md
          - cmd/timoni_inspect_values.md
          - cmd/timoni_inspect_resources.md
          - cmd/timoni_status.md
      - Module:
          - cmd/timoni_mod.md
          - cmd/timoni_mod_init.md
          - cmd/timoni_mod_push.md
          - cmd/timoni_mod_pull.md
          - cmd/timoni_mod_list.md
          - cmd/timoni_mod_vet.md
          - cmd/timoni_mod_vendor.md
          - cmd/timoni_mod_vendor_k8s.md
          - cmd/timoni_mod_vendor_crd.md
      - Bundle:
          - cmd/timoni_bundle.md
          - cmd/timoni_bundle_apply.md
          - cmd/timoni_bundle_build.md
          - cmd/timoni_bundle_delete.md
          - cmd/timoni_bundle_status.md
          - cmd/timoni_bundle_vet.md
      - Runtime:
          - cmd/timoni_runtime.md
          - cmd/timoni_runtime_build.md
      - Registry:
          - cmd/timoni_registry.md
          - cmd/timoni_registry_login.md
          - cmd/timoni_registry_logout.md
      - Artifact:
          - cmd/timoni_artifact.md
          - cmd/timoni_artifact_list.md
          - cmd/timoni_artifact_push.md
          - cmd/timoni_artifact_pull.md
      - Completion:
          - cmd/timoni_completion.md
          - cmd/timoni_completion_bash.md
          - cmd/timoni_completion_fish.md
          - cmd/timoni_completion_powershell.md
          - cmd/timoni_completion_zsh.md