hugo.yaml

baseURL: https://kafka.apache.org/
title: Apache Kafka

# cSpell:ignore goldmark github hugo readingtime docsy subdir lastmod pygments linenos catmullrom norsk gu

# Language settings
contentDir: content/en
defaultContentLanguage: en
defaultContentLanguageInSubdir: false
# Useful when translating.
enableMissingTranslationPlaceholders: true

enableRobotsTXT: true

# Will give values to .Lastmod etc.
enableGitInfo: true

# Comment out to enable taxonomies in Docsy
# disableKinds: [taxonomy, taxonomyTerm]

# You can add your own taxonomies
taxonomies:
  tag: tags
  category: categories

# Highlighting config
pygmentsCodeFences: true
pygmentsUseClasses: false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic: false
# pygmentsOptions: "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle: tango

# Configure how URLs look like per section.
permalinks:
  blog: /:section/:year/:month/:day/:slug/

# Image processing configuration.
imaging:
  resampleFilter: CatmullRom
  quality: 75
  anchor: Smart

# Language configuration
languages:
  en:
    languageName: English
    title: Apache Kafka
    params:
      description: Apache Kafka

markup:
  goldmark:
    parser:
      attribute:
        block: true
    renderer:
      unsafe: true
  highlight:
    # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
    style: tango
    # Uncomment if you want your chosen highlight style used for code blocks without a specified language
    # guessSyntax: true
  tableOfContents:
    endLevel: 3
    ordered: false
    startLevel: 1


# Everything below this are Site Params

# Comment out if you don't want the "print entire section" link enabled.
outputs:
  section: [HTML, print, RSS]

# menu:
#   main:
#     - name: doc
#       url: /latest/docs/
#       weight: 1
      
#     - name: "Documentation"
#       url: "/latest/docs/"
#       weight: 1
#     - name: "Version 1.0"
#       url: "/v1.0/docs/"
#       weight: 2
#     - name: "Version 2.0"
#       url: "/v2.0/docs/"
#       weight: 3

menu:
  main:
    # Get Started menu
    - name: "Get Started"
      url: "{{VERSION}}/getting-started/"
      weight: 10
    - name: "Introduction"
      parent: "Get Started"
      url: "/intro"
      weight: 11
    - name: "Quickstart"
      parent: "Get Started"
      url: "/quickstart"
      weight: 12
    - name: "Use Cases"
      parent: "Get Started"
      url: "/uses"
      weight: 13
    - name: "Books and Papers"
      parent: "Get Started"
      url: "/books-and-papers"
      weight: 14
    - name: "Videos"
      parent: "Get Started"
      url: "/videos"
      weight: 15
    - name: "Podcasts"
      parent: "Get Started"
      url: "/podcasts"
      weight: 16

    # Docs menu
    - name: "Docs"
      url: "/documentation"
      weight: 20
    - name: "Key Concepts"
      parent: "Docs"
      url: "/documentation#gettingStarted"
      weight: 21
    - name: "APIs"
      parent: "Docs"
      url: "/documentation#api"
      weight: 22
    - name: "Configuration"
      parent: "Docs"
      url: "/documentation#configuration"
      weight: 23
    - name: "Design"
      parent: "Docs"
      url: "/documentation#design"
      weight: 24
    - name: "Implementation"
      parent: "Docs"
      url: "/documentation#implementation"
      weight: 25
    - name: "Operations"
      parent: "Docs"
      url: "/documentation#operations"
      weight: 26
    - name: "Security"
      identifier: "docs_security"
      parent: "Docs"
      url: "/documentation#security"
      weight: 27
    - name: "Clients"
      parent: "Docs"
      url: "https://cwiki.apache.org/confluence/display/KAFKA/Clients"
      weight: 28
    - name: "Kafka Connect"
      parent: "Docs"
      url: "/documentation#connect"
      weight: 29
    - name: "Kafka Streams"
      parent: "Docs"
      url: "/documentation/streams"
      weight: 30

    # Powered By menu item
    - name: "Powered By"
      url: "/powered-by/"
      weight: 35

    # Community menu
    - name: "Community"
      url: "/community/"
      weight: 40
    - name: "Blog"
      parent: "Community"
      url: "/blog/"
      weight: 41
    - name: "Kafka Summit"
      parent: "Community"
      url: "https://kafka-summit.org"
      weight: 42
    - name: "Project Info"
      parent: "Community"
      url: "/project/"
      weight: 43
    - name: "Trademark"
      parent: "Community"
      url: "/community/trademark/"
      weight: 44
    - name: "Ecosystem"
      parent: "Community"
      url: "https://cwiki.apache.org/confluence/display/KAFKA/Ecosystem"
      weight: 45
    - name: "Events"
      parent: "Community"
      url: "/community/events/"
      weight: 46
    - name: "Contact Us"
      parent: "Community"
      url: "/community/contact/"
      weight: 47
    
    # Apache menu
    - name: "Apache"
      url: "https://www.apache.org/"
      weight: 50
    - name: "Apache.org"
      parent: "Apache"
      url: "https://www.apache.org/"
      weight: 51
    - name: "License"
      parent: "Apache"
      url: "https://www.apache.org/licenses/"
      weight: 52
    - name: "Donate"
      parent: "Apache"
      url: "https://www.apache.org/foundation/contributing.html"
      weight: 53
    - name: "Sponsors"
      parent: "Apache"
      url: "https://www.apache.org/foundation/thanks.html"
      weight: 54
    - name: "Security"
      identifier: "apache_security"
      parent: "Apache"
      url: "https://www.apache.org/security/"
      weight: 55
    - name: "Privacy"
      parent: "Apache"
      url: "{{PRIVACY}}"
      weight: 56
    
    # DOWNLOAD KAFKA as gradient button (handled in navbar.html)
    - name: "DOWNLOAD KAFKA"
      url: "/community/downloads/"
      weight: 60
      # This will be styled as a gradient button in navbar.html

params:
  # Latest documentation version - UPDATE THIS WHEN RELEASING NEW VERSION
  latest_version: "43"
  latest_version_number: "4.3"
  
  # The version number for the version of the docs represented in this doc set.
  # Used in the "version-banner" partial to display a version number for the
  # current doc set.
  # NOTE: This is automatically set from latest_version_number parameter above
  version: 4.3

  # A link to latest version of the docs. Used in the "version-banner" partial to
  # point people to the main doc site.
  # NOTE: When updating to version 43, change this to /43/
  url_latest_version: /43/

  # Menu title if your navbar has a versions selector to access old versions of your site.
  # This menu appears only if you have at least one [params.versions] set.
  version_menu: Releases

  # Flag used in the "version-banner" partial to decide whether to display a
  # banner on every page indicating that this is an archived version of the docs.
  # Set this flag to "true" if you want to display the banner.
  archived_version: true

  versions:
    # NOTE: When adding version 44, update params.latest_version to "44"
    # and params.latest_version_number to "4.4" at the top
    - version: "4.3"
      url: /43/
    - version: "4.2"
      url: /42/
      archived_version: true
    - version: "4.1"
      url: /41/
      archived_version: true
    - version: "4.0"
      url: /40/
      archived_version: true
    - version: "3.9"
      url: /39/
      archived_version: true
    - version: "3.8"
      url: /38/
      archived_version: true
    - version: "3.7"
      url: /37/
      archived_version: true
    - version: "3.6"
      url: /36/
      archived_version: true
    - version: "3.5"
      url: /35/
      archived_version: true
    - version: "3.4"
      url: /34/
      archived_version: true
    - version: "3.3"
      url: /33/
      archived_version: true
    - version: "3.2"
      url: /32/
      archived_version: true
    - version: "3.1"
      url: /31/
      archived_version: true
    - version: "3.0"  
      url: /30/
      archived_version: true
    - version: "2.8"
      url: /28/
      archived_version: true
    - version: "2.7"
      url: /27/
      archived_version: true
    - version: "2.6"  
      url: /26/
      archived_version: true
    - version: "2.5"
      url: /25/
      archived_version: true
    - version: "2.4"
      url: /24/
      archived_version: true
    - version: "2.3"  
      url: /23/
      archived_version: true
    - version: "2.2"
      url: /22/
      archived_version: true
    - version: "2.1"
      url: /21/
      archived_version: true
    - version: "2.0"  
      url: /20/
      archived_version: true
    - version: "1.1"
      url: /11/
      archived_version: true
    - version: "1.0"
      url: /10/
      archived_version: true
    - version: "0.11.0"
      url: /0110/
      archived_version: true
    - version: "0.10.2"
      url: /0102/
      archived_version: true
    - version: "0.10.1"
      url: /0101/
      archived_version: true
    - version: "0.10.0"
      url: /0100/
      archived_version: true
    - version: "0.9.0"
      url: /090/
      archived_version: true
    - version: "0.8.2"
      url: /082/
      archived_version: true
    - version: "0.8.1"
      url: /081/
      archived_version: true
    - version: "0.8.0"
      url: /08/
      archived_version: true
    - version: "0.7"
      url: /07/
      archived_version: true
  
  # Favicon configuration
  favicon: /images/apache.png
  
  print: 
    disable_toc: false
  taxonomy:
    # set taxonomyCloud = [] to hide taxonomy clouds
    taxonomyCloud: [tags, categories]

    # If used, must have same length as taxonomyCloud
    taxonomyCloudTitle: [Tag Cloud, Categories]

    # set taxonomyPageHeader = [] to hide taxonomies on the page headers
    taxonomyPageHeader: [tags, categories]

  privacy_policy: https://privacy.apache.org/policies/privacy-policy-public.html

  # First one is picked as the Twitter card image if not set on page.
  # images: [images/project-illustration.png]

  # Repository configuration (URLs for in-page links to opening issues and suggesting changes)
  github_repo: https://github.com/apache/kafka-site/

  # An optional link to a related project repo. For example, the sibling repository where your product code lives.
  # github_project_repo: https://github.com/google/docsy

  # Specify a value here if your content directory is not in your repo's root directory
  # github_subdir: ""

  # Uncomment this if your GitHub repo does not have "main" as the default branch,
  # or specify a new value if you want to reference another branch in your GitHub links
  github_branch: markdown

  # Google Custom Search Engine ID. Remove or comment out to disable search.
  # gcs_engine_id: d72aa9b2712488cc3

  # Enable Lunr.js offline search
  offlineSearch: true

  # Enable syntax highlighting and copy buttons on code blocks with Prism
  prism_syntax_highlighting: false

  copyright:
    authors: By [Apache Software Foundation](https://www.apache.org/) under the terms of the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0)
    from_year: 2014

  # User interface configuration
  ui:
    # Set to true to disable breadcrumb navigation.
    breadcrumb_disable: false
    # Show prev/next navigation links at the bottom of each docs page
    showPrevNext: true
    # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
    navbar_logo: true
    # logo: /logos/kafka-logo-no-text.png
    # logo: /assets/kafka.svg
    # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
    navbar_translucent_over_cover_disable: true
    # Enable to show the side bar menu in its compact state.
    sidebar_menu_compact: false
    # Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
    sidebar_search_disable: true
    sidebar_menu_foldable: true

    # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
    # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
    # If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
    # add "hide_feedback: true" to the page's front matter.
    feedback:
      enable: false
      # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
      'yes': >-
        Glad to hear it! Please <a href="https://github.com/apache/kafka-site/issues/new">tell us how we can improve</a>.
      'no': >-
        Sorry to hear that. Please <a href="https://github.com/apache/kafka-site/issues/new">tell us how we can improve</a>.

    # Adds a reading time to the top of each doc.
    # If you want this feature, but occasionally need to remove the Reading time from a single page,
    # add "hide_readingtime: true" to the page's front matter
    readingtime:
      enable: false


  links:
    # End user relevant links. These will show up on left side of footer and in the community page if you have one.
    user:
      - name: Contact
        url: /community/contact/
        icon: fa fa-envelope
        desc: Discussion and help from your fellow users
      - name: Twitter
        url: https://twitter.com/apachekafka
        icon: fab fa-twitter
        desc: Follow us on Twitter to get the latest news!
      - name: Stack Overflow
        url: https://stackoverflow.com/questions/tagged/apache-kafka
        icon: fab fa-stack-overflow
        desc: Apache Kafka questions on Stack Overflow
    # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
    developer:
      - name: GitHub
        url: https://github.com/apache/kafka
        icon: fab fa-github
        desc: Apache Kafka source code
      - name: Developer mailing list
        url: mailto:dev@kafka.apache.org
        icon: fa fa-envelope
        desc: Developer mailing list

  search:
    # Indexing directories - latest version is automatically included
    # by reading params.latest_version in the search index template
    indexing_directories:
      - "blog"
      - "community"
      - "testimonials"
    exclude_sections:
      - "internal"
    min_word_length: 3
    # Latest version docs are indexed automatically (see _default/index.json)

module:
  # Uncomment the next line to build and serve using local docsy clone declared in the named Hugo workspace:
  # workspace: docsy.work
  hugoVersion:
    extended: true
    min: 0.110.0
  imports:
    - path: github.com/google/docsy
      disable: false
  # From 4.3 onward, each release ships its `generated/` artifacts under
  # content/en/<v>/generated/ (matching apache/kafka's docs/generated layout).
  # The catch-all mount below re-exposes them at /<v>/generated/ URLs without
  # per-release hugo.yaml edits. Pre-4.3 versions keep their files in
  # static/<v>/generated/ and are unaffected.
  mounts:
    - source: content/en
      target: content
      lang: en
      excludeFiles:
        - "[0-9]*/generated/**"
    - source: data
      target: data
    - source: layouts
      target: layouts
    - source: assets
      target: assets
    - source: static
      target: static
    - source: content/en
      target: static
      includeFiles:
        - "[0-9]*/generated/**"