page_baseurl_generator.rb

# frozen_string_literal: true

# Copyright © Magento, Inc. All rights reserved.
# See COPYING.txt for license details.

# Author: jcalcaben@magento.com
#
# This custom plugin dynamically sets and injects the page.baseurl variable
# based on the page's destination.
#
# The hook introduces the page.baseurl parameter for each page.
# For pages at guides/v2.x the page.baseurl parameter is set
# as "{site.baseurl}/guides/v#{version}".
# The {version} is taken from the 'guide_version' front matter parameter on the page;
# if it is not set, then the 'guide_version' is set to version from the _config.yml depending on a scope by path (for example, "2.4" at the "guides/v2.4/");
# otherwise, the version is unset and returns the nil object (same as null).
Jekyll::Hooks.register :pages, :post_init do |page|
  # Glossary. Create and assign variables to be used in the script.
  baseurl = page.site.baseurl
  data = page.data
  version = data['guide_version']

  # Create 'page.baseurl' parameter
  data['baseurl'] =
    if version
      "#{baseurl}/guides/v#{version}"
    else
      baseurl
    end
end