mkdocs.yml

---
site_name: Kubitect

repo_url: https://github.com/musicdin/kubitect
repo_name: MusicDin/kubitect

# Remove docs edit button
edit_uri: ""

theme:
  name: material
  custom_dir: docs/

  favicon: assets/images/favicon.svg
  logo: assets/images/logo_white.svg

  font:
    text: Ubuntu

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to system preference

  features:
    - content.code.annotate
    #- content.tabs.link
    - navigation.expand
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  icon:
    repo: octicons/mark-github-16
    admonition:
      note: octicons/pencil-24
      abstract: octicons/checklist-24
      info: octicons/info-24
      tip: octicons/light-bulb-24
      success: octicons/check-24
      question: octicons/question-24
      warning: octicons/alert-24
      failure: octicons/x-24
      danger: octicons/zap-24
      bug: octicons/bug-24
      example: octicons/beaker-24
      quote: octicons/quote-24

extra_css:
  - assets/stylesheets/style.css

extra_javascript:
  - assets/javascripts/extra.js

extra:
  version:
    provider: mike
    default: latest

plugins:
  - search
  - minify:
      minify_html: true

markdown_extensions:
  - attr_list
  - admonition
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite

  # Content tabs
  - pymdownx.tabbed:
      alternate_style: true

  # Emoji
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
        # Page tree

        # - pymdownx.highlight:
        #     linenums: true
        #     anchor_linenums: true
        #     linenums_style: pymdownx-inline


  - toc:
      permalink: "🔗︎" # Link symbol
      permalink_title: Anchor link

nav:
  - Home: index.md
  - Getting started:
      - Getting started:
          - Introduction: getting-started/introduction.md
          - Installation: getting-started/installation.md
          - Requirements: getting-started/requirements.md
          - Quick start: getting-started/quick-start.md
          - Getting started (step-by-step): getting-started/getting-started.md
      - Other:
          - Local development: getting-started/other/local-development.md
          - Troubleshooting: getting-started/other/troubleshooting.md
  - User guide:
      - User guide:
          - Before you begin: user-guide/before-you-begin.md
      - Cluster Management:
          # - Creating the cluster: user-guide/management/creating.md
          - Upgrading the cluster: user-guide/management/upgrading.md
          - Scaling the cluster: user-guide/management/scaling.md
          - Destroying the cluster: user-guide/management/destroying.md
      - Configuration:
          - Hosts: user-guide/configuration/hosts.md
          - Cluster name: user-guide/configuration/cluster-name.md
          - Cluster network: user-guide/configuration/cluster-network.md
          - Cluster node template: user-guide/configuration/cluster-node-template.md
          - Cluster nodes: user-guide/configuration/cluster-nodes.md
          - Kubernetes: user-guide/configuration/kubernetes.md
          - Addons: user-guide/configuration/addons.md
      - Reference:
          - Configuration reference: user-guide/reference/configuration.md
          - CLI tool reference: user-guide/reference/cli.md
  - Examples:
      - Cluster Topologies:
          - Single node cluster: examples/single-node-cluster.md
          - Multi-worker cluster: examples/multi-worker-cluster.md
          - Multi-master cluster: examples/multi-master-cluster.md
          - Highly available (HA) cluster: examples/ha-cluster.md
      - Storage:
          - Rook cluster: examples/rook-cluster.md
      - Other:
          - Accessing the cluster: examples/accessing-cluster.md
          - Network bridge: examples/network-bridge.md
          # - Full example: examples/full-example.md