mkdocs.yml

site_name: kobs
site_description: Kubernetes Observability Platform
repo_name: kobsio/kobs
repo_url: https://github.com/kobsio/kobs
edit_uri: https://github.com/kobsio/kobs/edit/main/docs/
copyright: Copyright © 2023 Rico Berger

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/images/favicon.png
  logo: assets/images/logo.png
  include_search_page: false
  search_index_only: true
  palette:
    primary: custom
  features:
    - navigation.tabs

nav:
  - Home: index.md
  - Getting Started:
      - getting-started/index.md
      - Installation:
          - Helm: getting-started/installation/helm.md
          - Kustomize: getting-started/installation/kustomize.md
      - Configuration:
          - cluster: getting-started/configuration/cluster.md
          - hub: getting-started/configuration/hub.md
          - watcher: getting-started/configuration/watcher.md
  - Resources:
      - resources/index.md
      - Kubernetes Resources: resources/kubernetes-resources.md
      - Applications: resources/applications.md
      - Users: resources/users.md
      - Teams: resources/teams.md
      - Dashboards: resources/dashboards.md
  - Plugins:
      - plugins/index.md
      - Azure: plugins/azure.md
      - Datadog: plugins/datadog.md
      - Elasticsearch: plugins/elasticsearch.md
      - Flux: plugins/flux.md
      - GitHub: plugins/github.md
      - Grafana: plugins/grafana.md
      - Harbor: plugins/harbor.md
      - Helm: plugins/helm.md
      - Jaeger: plugins/jaeger.md
      - Jira: plugins/jira.md
      - Kiali: plugins/kiali.md
      - klogs: plugins/klogs.md
      - MongoDB: plugins/mongodb.md
      - Opsgenie: plugins/opsgenie.md
      - Prometheus: plugins/prometheus.md
      - RSS: plugins/rss.md
      - Runbooks: plugins/runbooks.md
      - Signal Sciences: plugins/signalsciences.md
      - SonarQube: plugins/sonarqube.md
      - SQL: plugins/sql.md
      - TechDocs: plugins/techdocs.md
      - Velero: plugins/velero.md
  - Community Plugins:
      - community-plugins/index.md
  - Contributing:
      - contributing/index.md
      - Create a Plugin: contributing/create-a-plugin.md
      - Use Custom Plugins: contributing/use-custom-plugins.md
      - Release: contributing/release.md

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - docs/overrides/.icons
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  social:
    - icon: material/web
      link: https://kobs.io
    - icon: fontawesome/brands/github
      link: https://github.com/kobsio/kobs
    - icon: fontawesome/brands/docker
      link: https://github.com/orgs/kobsio/packages
  version:
    provider: mike

extra_css:
  - assets/stylesheets/extra.css