mkdocs.yml

# dependencies:
# pip install mkdocs mkdocs-material pymdown-extensions
site_name: "Kapitan: Keep your ship together"
site_url: "https://kapitan.dev"
strict: true
plugins:
  - tags:
      tags_file: tags.md
  - search
extra_css:
  - stylesheets/custom.css
theme:
  name: material
  custom_dir: overrides
  logo: images/kapitan_logo.png
  favicon: images/kapitan_logo.png
  features:
    - announce.dismiss
    - content.code.annotate
    - content.tabs.link
    - navigation.instant
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  palette:
    # Palette toggle for light mode
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/kapitandev
      name: kapitan on Twitter
    - icon: fontawesome/brands/slack
      link: https://kubernetes.slack.com/archives/C981W2HD3
      name: "#kapitan slack channel"
  analytics:
    provider: google
    property: G-5E934SC0R8
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
use_directory_urls: true
nav:
  - Home: README.md
  - Getting started: getting_started.md
      

  - Documentation:
      - Overview: pages/kapitan_overview.md
      - Inventory:
        - Introduction: pages/inventory/introduction.md
        - Targets: pages/inventory/targets.md
        - Classes: pages/inventory/classes.md
        - Parameters Interpolation: pages/inventory/parameters_interpolation.md
        - Advanced: pages/inventory/advanced.md

      - Input Types:
          - Introduction: pages/input_types/introduction.md
          - Kadet: pages/input_types/kadet.md
          - Jinja: pages/input_types/jinja.md
          - Helm: pages/input_types/helm.md
          - Jsonnet: pages/input_types/jsonnet.md
          - External: pages/input_types/external.md
          - Copy: pages/input_types/copy.md
          - Remove: pages/input_types/remove.md
      - References: references.md
      - Advanced Kapitan:
        - Remote repositories: pages/remote_repositories.md
        - External dependencies: pages/external_dependencies.md
      - CLI reference:
          - compile: pages/commands/kapitan_compile.md
          - inventory: pages/commands/kapitan_inventory.md
          - lint: pages/commands/kapitan_lint.md
          - searchvar: pages/commands/kapitan_searchvar.md
          - validate: pages/commands/kapitan_validate.md
          - kapitan dotfile: pages/commands/kapitan_dotfile.md
  - Examples:
      - Kubernetes: pages/examples/kubernetes.md
      - Terraform: pages/examples/terraform.md
  - Blog:
    - 2023:
      - Kapitan Generators: pages/blog/2023-08-27.md
      - New Kapitan release: pages/blog/2023-01-16.md
    - 2022:
      - 5 years of Kapitan: pages/blog/2022-12-04.md
  - Support:
      - Ask for support: support.md
      - Related Projects: related.md
  - Contribute:
      - Sponsor Us: pages/contribute/sponsor.md
      - Talk about Kapitan: pages/contribute/talk.md
      - Active contributions:
        - Documentation: pages/contribute/documentation.md
        - Kapitan Code: pages/contribute/code.md
        - Proposals: proposals.md
  - FAQ: FAQ.md

markdown_extensions:
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.snippets:
      base_path: examples
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - markdown_include.include:
      base_path: docs
  - attr_list
  - abbr

repo_name: "kapicorp/kapitan"
repo_url: "https://github.com/kapicorp/kapitan"

copyright: >
  <a href="#__consent">Change cookie settings</a>