mkdocs.yml

# Project
site_name: KICS
site_url: http://docs.kics.io
site_description: >-
  Open source solution for static code analysis of Infrastructure as Code. Finding security vulnerabilities, compliance issues, and infrastructure misconfigurations during project development cycle.
copyright: >-
  © 2021 Checkmarx Ltd. All Rights Reserved.

# Repo
repo_name: GitHub
repo_url: https://github.com/Checkmarx/kics/

extra:
  version:
    provider: mike

theme:
  name: material
  logo: img/logo/kics_hat_color_new.png
  favicon: img/logo/kics-hat.ico
  features:
    - navigation.tabs
    - navigation.tabs.sticky
  palette:
    - scheme: kics
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# Navigation
nav:
  - Getting Started:
      - Installation: getting-started.md
      - Configuration: configuration-file.md
      - Command Line Interface: commands.md
      - Running KICS: running-kics.md
      - Results: results.md
      - Architecture: architecture.md
      - Platforms: platforms.md
      - Changes in v1.3.0: changes.md
  - Queries:
      - General Info: queries.md
      - Creating Queries: creating-queries.md
      - Passwords And Secrets: secrets.md
      - Bill of Materials: bom.md
      - Queries List:
          - All: queries/all-queries.md
          - Ansible: queries/ansible-queries.md
          - Azure Resource Manager: queries/azureresourcemanager-queries.md
          - CloudFormation: queries/cloudformation-queries.md
          - Dockerfile: queries/dockerfile-queries.md
          - Kubernetes: queries/kubernetes-queries.md
          - Terraform: queries/terraform-queries.md
          - OpenAPI: queries/openapi-queries.md
  - Integrations:
      - Overview: integrations.md
      - Azure DevOps: integrations_azurepipelines.md
      - Bamboo: integrations_bamboo.md
      - Bitbucket Pipelines: integrations_bitbucketpipelines.md
      - CircleCI: integrations_circleci.md
      - Github Actions: integrations_ghactions.md
      - Gitlab CI: integrations_gitlabci.md
      - Jenkins: integrations_jenkins.md
      - TeamCity: integrations_teamcity.md
      - Travis CI: integrations_travisci.md
      - Terraform Cloud: integration_tfcloud.md
      - AWS CDK: cdk.md
      - AWS CodeBuild: integrations_aws_codebuild.md
      - Badge: BADGE.md
      - Using pre-commit hooks: integrations_pre_commit.md
      - Terraformer: integrations_terraformer.md
  - Certifications: certifications.md
  - Project:
      - Roadmap: roadmap.md
      - Plans: "https://github.com/Checkmarx/kics/projects"
      - Issues: "https://github.com/Checkmarx/kics/issues"
      - Releases: releases.md
      - Performance: performance.md
  - Contribution: CONTRIBUTING.md
  - About: about.md

extra_css:
  - css/custom.css

extra_javascript:
  - js/version-mike.js
  - js/custom.js

# Plugins
plugins:
  - search:
      prebuild_index: true
google_analytics:
  - UA-186818347-2
  - auto

markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 2
      separator: "_"