jekyll-dev.yml

# Build settings
# This file is for local builds
# Any changes made in this file should also be made in jekyll.yml
source: app
destination: dist
permalink: pretty
timezone: America/San_Francisco
markdown: kramdown
kramdown:
  syntax_highlighter: rouge
  syntax_highlighter_opts:
    css_class: "highlight"
    guess_lang: true
incremental: true

keep_files:
  - assets

# Site settings
name: Kong Docs
title: Kong Docs
description: "Documentation for Kong, the Cloud Connectivity Company for APIs and Microservices."
links:
  web: http://localhost:4000
  share: https://docs.konghq.com # legacy link, must maintain for social sharing counters
  download: https://cloudsmith.io/~kong/repos
  direct: https://packages.konghq.com/public
  instaclustr: "https://www.instaclustr.com/products/kong/?utm_source=partnership&utm_medium=link&utm_campaign=mashape"
  learn: https://education.konghq.com # kong academy
  archive: https://legacy-gateway--kongdocs.netlify.app
  locales:
    ja: https://docs.jp.konghq.com
    en: http://localhost:4000
repos:
  kong: https://github.com/Kong/kong
  docs: https://github.com/Kong/docs.konghq.com
  vagrant: https://github.com/Kong/kong-vagrant
  homebrew: https://github.com/Kong/homebrew-kong
  cloudformation: https://github.com/Kong/kong-dist-cloudformation

# for Kong platform extensions (not Jekyll)
extensions:
  categories: &plugin_categories
    - name: AI
      slug: ai
      desc: Govern, secure, and control AI traffic with multi-LLM AI Gateway plugins
      icon: /assets/images/nav/hub/ai.svg
    - name: Authentication
      slug: authentication
      desc: Protect your services with an authentication layer
      icon: /assets/images/nav/hub/lock_person.svg
    - name: Security
      slug: security
      desc: Protect your services with additional security layer
      icon: /assets/images/nav/hub/shield.svg
    - name: Traffic Control
      slug: traffic-control
      desc: Manage, throttle and restrict inbound and outbound API traffic
      icon: /assets/images/nav/hub/route.svg
    - name: Serverless
      slug: serverless
      desc: Invoke serverless functions in combination with other plugins
      icon: /assets/images/nav/hub/serverless.svg
    - name: Analytics & Monitoring
      slug: analytics-monitoring
      desc: Visualize, inspect and monitor APIs and microservices traffic
      icon: /assets/images/nav/hub/bar_chart.svg
    - name: Transformations
      slug: transformations
      desc: Transform request and responses on the fly on Kong
      icon: /assets/images/nav/hub/swap_horiz.svg
    - name: Logging
      slug: logging
      desc: Log request and response data using the best transport for your infrastructure
      icon: /assets/images/nav/hub/list_alt.svg
  types:
    - name: plugin
      slug: plugin
    - name: integration
      slug: integration
    # - name: dev portal extension
    #   slug: dev-mod

exclude:
  - node_modules
  - jekyll-cache
  - app/assets

# location vars
icons_dir: assets/images/icons
include:
  - _headers

plugins:
  - jekyll-redirect-from
  - jekyll-include-cache
  - jekyll-generator-single-source
  - jekyll/vite

defaults:
  - scope:
      path: ""
    values:
      layout: "docs-v2"

  - scope:
      path: "assets"
    values:
      layout: null

  - scope:
      path: "deck"
    values:
      layout: "docs-v2"

  - scope:
      path: "mesh"
    values:
      layout: "docs-v2"

  - scope:
      path: "kubernetes-ingress-controller"
    values:
      layout: "docs-v2"

  - scope:
      path: "gateway-operator"
    values:
      layout: "docs-v2"

  - scope:
      path: "konnect"
    values:
      layout: "docs-v2"
      no_version: true

  - scope:
      path: "gateway"
    values:
      layout: "docs-v2"

  - scope:
      path: "gateway/2.6.x/"
    values:
      layout: "docs-v2"
      version-index: 0

  - scope:
      path: "gateway/2.7.x/"
    values:
      layout: "docs-v2"
      version-index: 1

  - scope:
      path: "gateway/2.8.x/"
    values:
      layout: "docs-v2"
      version-index: 2

  - scope:
      path: "gateway/2.8.x/"
    values:
      layout: "docs-v2"
      version-index: 2

  - scope:
      path: "gateway/3.1.x/"
    values:
      layout: "docs-v2"
      version-index: 4

  - scope:
      path: "about"
    values:
      layout: "about"
      header_html: '<a class="github-button" href="https://github.com/Kong/kong" data-style="mega" data-count-href="/Kong/kong/stargazers" data-count-api="/repos/Kong/kong#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star Kong/kong on GitHub">Star</a>&nbsp;<a class="github-button" href="https://github.com/Kong/kong/fork" data-icon="octicon-repo-forked" data-style="mega" data-count-href="/Kong/kong/network" data-count-api="/repos/Kong/kong#forks_count" data-count-aria-label="# forks on GitHub" aria-label="Fork Kong/kong on GitHub">Fork</a>'
      breadcrumbs: null

  - scope:
      type: hub
    values:
      layout: extension
      permalink: /:collection/:path

  - scope:
      path: "contributing"
    values:
      layout: "docs-v2"
      no_version: true

hub-filters:
  tiers:
    - name: Free
      slug: free
    - name: Kong Gateway Enterprise
      slug: enterprise
  support:
    - name: Kong
      slug: kong-inc
    - name: Premium partner
      slug: premium-partner
    - name: Support by 3rd party
      slug: community
  compatibility:
    - name: Konnect
      slug: konnect
  categories:
    *plugin_categories

# product name vars
ee_product_name: Kong Gateway Enterprise
ce_product_name: Kong Gateway (OSS)
base_gateway: Kong Gateway
kgo_product_name: Kong Gateway Operator
kic_product_name: Kong Ingress Controller
konnect_product_name: Kong Konnect
konnect_short_name: Konnect
konnect_saas: Kong Konnect
package_name: Kong Konnect
company_name: Kong Inc.
mesh_product_name: Kong Mesh
deck_product_name: decK
contributing_product_name: Contribution Guidelines
service_catalog_name: Service Catalog
# Mesh specific config
mesh_namespace: kong-mesh-system
mesh_cp_name: kong-mesh-control-plane
mesh_ignored_links_regex:
  - '\[.*\]\(https:\/\/github\.com\/[kK]ong\/kong-mesh.*\)'
mesh_raw_generated_paths:
  - app/assets/mesh
  - app/_src/.repos/kuma/app/assets
# Helm commands
set_flag_values_prefix: kuma.
mesh_helm_repo_url: https://kong.github.io/kong-mesh-charts
mesh_helm_repo_name: kong-mesh
mesh_helm_repo: kong-mesh/kong-mesh
mesh_helm_install_name: kong-mesh
mesh_disabled_versions: []
# binary options
mesh_install_archive_name: kong-mesh

jekyll-generator-single-source:
  versions_file: '_data/kong_versions.yml'
  docs_nav_folder: '_data'

locale: en-US