mkdocs.yml

site_name: Cluster.dev
# Page tree
repo_name: 'shalb/cluster.dev'
repo_url: 'https://github.com/shalb/cluster.dev'
site_url: 'https://docs.cluster.dev'


nav:
  - Introduction:
    - Overview:
      - What Is Cluster.dev?: index.md
      - How Does It Work?: how-does-cdev-work.md
    - Installation and Upgrade: installation-upgrade.md
  - Getting Started:
    - Overview: get-started-overview.md
    - Quick Start on AWS: get-started-cdev-aws.md
    - Quick Start on Azure: get-started-cdev-azure.md
    - Quick Start on GCP: get-started-cdev-gcp.md
    - Quick Start with Kubernetes: get-started-cdev-helm.md
  - Examples:
    - Overview: examples-overview.md
    - AWS-EKS: examples-aws-eks.md
    - AWS-K3s: examples-aws-k3s.md
    - Azure-AKS: examples-azure-aks.md
    - GCP-GKE: examples-gcp-gke.md
    - AWS-K3s Prometheus: examples-aws-k3s-prometheus.md
    - DO-K8s: examples-do-k8s.md
    - Modify AWS-EKS: examples-modify-aws-eks.md
    - HF LLM in EKS: examples-eks-model.md
  - Reference:
    - Structure:
      - Overview: structure-overview.md
      - Project: structure-project.md
      - Stack: structure-stack.md
      - Backends: structure-backend.md
      - Secrets: structure-secrets.md
      - State: cluster-state.md
    - Units:
      - Overview: units-overview.md
      - Shell: units-shell.md
      - Tfmodule: units-terraform.md
      - Helm: units-helm.md
      - Kubernetes: units-kubernetes.md
      - K8s-manifest: units-k8s-manifest.md
      - Printer: units-printer.md
    - Variables: variables.md
    - Stack Templates:
      - Overview: stack-templates-overview.md
      - Functions: stack-templates-functions.md
      - Templating: templating.md
      - File System: stack-templates-file-system.md
      - Generators: generators-overview.md
    - CLI Reference:
      - CLI Commands: cli-commands.md
      - CLI Options: cli-options.md
      - Environment variables: env-variables.md
    - How-to Articles:
      - Use Different Terraform versions: howto-tf-versions.md
  - Resources:
    - External Articles: examples-external-articles.md
    - Cluster.dev vs. Other Technologies:
      - Cluster.dev vs. Terragrunt: cdev-vs-terragrunt.md
      - Cluster.dev vs. Helmfile: cdev-vs-helmfile.md
      - Cluster.dev vs. Terraform: cdev-vs-terraform.md
      - Cluster.dev vs. Pulumi & Crossplane: cdev-vs-pulumi.md


markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.inlinehilite
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences
  - pymdownx.tilde
  - toc:
      permalink: ' ¶'
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
theme:
  name: 'material'
  custom_dir: docs/theme-overrides
  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true
  language: en
  features:
    - navigation.tabs
    - content.code.copy
    - content.code.select
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: black
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mod
  font:
    text: Roboto
    code: Roboto Mono
  logo: '/images/cluster-dev-logo-site.png'
  favicon: 'images/favicon.png'
extra:
  social:
    - icon: fontawesome/brands/medium
      link: https://medium.com/@cluster.dev
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/cluster-dev/shared_invite/zt-eg4q6jae-v0~zgrBLYTTXt~CjnjmprA
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/cluster__dev
    - icon: fontawesome/brands/github
      link: https://github.com/shalb/cluster.dev
      extra:
  analytics:
    provider: gtm