mkdocs.yml

site_name: Flux
site_description: Documentation for Flux, the GitOps Kubernetes operator.
site_author: The Flux contributors
site_url: https://docs.fluxcd.io

# Repository
repo_name: fluxcd/flux
repo_url: https://github.com/fluxcd/flux
edit_uri: ""

theme:
  name: material
  logo: _files/flux-icon@2x.png
  language: en
  palette:
    primary: blue
    accent: indigo
  custom_dir: docs_theme_override

docs_dir: docs

extra_css:
  - _static/custom.css

plugins:
  - search

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
  - pymdownx.superfences:
      highlight_code: true
  - pymdownx.tabbed

extra:
  social:
    - icon: fontawesome/solid/globe-europe
      link: https://fluxcd.io
    - icon: fontawesome/brands/github-alt
      link: https://github.com/fluxcd
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/fluxcd
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/groups/8985374

nav:
  - Introducing Flux: introduction.md
  - Requirements and limitations: requirements.md
  - Get Started: get-started/index.md
  - References:
    - Blueprint: references/blueprint.md
    - Daemon (fluxd): references/daemon.md
    - fluxctl: references/fluxctl.md
    - Manifest generation through .flux.yaml configuration files: references/fluxyaml-config-files.md
    - Garbage collection: references/garbagecollection.md
    - Git commit signing and verification: references/git-gpg.md
    - Automated deployment of new container images: references/automated-image-update.md
    - Monitoring Flux: references/monitoring.md
  - Guides:
    - Providing your own SSH key: guides/provide-own-ssh-key.md
    - Using Git over HTTPS: guides/use-git-https.md
    - Using a private Git host: guides/use-private-git-host.md
    - Upgrading to Flux v1: guides/upgrading-to-1.0.md
    - Using GKE Workload Identity: guides/use-gke-workload-identity.md
  - Tutorials:
    - Get started: tutorials/get-started.md
    - Get started using Helm: tutorials/get-started-helm.md
    - How to bootstrap Flux using Kustomize: tutorials/get-started-kustomize.md
    - Automations, locks and annotations: tutorials/driving-flux.md
  - Helm Operator:
    - Documentation: https://docs.fluxcd.io/projects/helm-operator/en/stable/
    - Flux integration: references/helm-operator-integration.md
  - Frequently asked questions: faq.md
  - Troubleshooting: troubleshooting.md
  - Contributing:
    - Get started developing: contributing/get-started-developing.md
    - Building Flux: contributing/building.md