mkdocs.yml

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 © 2024 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-sign.md': 'cue/module/signing.md'
        'module-distribution.md': 'cue/module/publishing.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
        - Multi-cluster deployments: bundle-multi-cluster.md
    - App Packaging:
        - Module specification: module.md
    - Integrations:
        - GitHub Actions: github-actions.md
        - Flux AIO Distribution: flux-aio.md
        - Helm Interoperability: flux-helm-interop.md
        - GitOps with Flux: gitops-flux.md
  - CUE Reference:
      - Introduction: cue/introduction.md
      - CUE Walkthrough: cue/walkthrough.md
      - Module Development:
          - Get started with modules: cue/module/initialization.md
          - Immutable ConfigMaps and Secrets: cue/module/immutable-config.md
          - Add custom resources: cue/module/custom-resources.md
          - Cluster version constraints: cue/module/semver-constraints.md
          - Control the apply behavior: cue/module/apply-behavior.md
          - Run tests with Kubernetes Jobs: cue/module/test-jobs.md
          - Import resources from YAML: cue/module/import-resources.md
      - Module Distribution:
          - Publishing module versions: cue/module/publishing.md
          - Signing and Verification: cue/module/signing.md
          - GitHub Actions: cue/module/github-actions.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
          - cmd/timoni_artifact_tag.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