_config.yml

# This file contains configuration settings for the devdocs website.
# Each setting is available on pages using Liquid {{ site.<config key> }}. For example, {{ site.title }}.
# For more details about available options and defaults, refer to https://jekyllrb.com/docs/configuration/
#
title: Magento 2 Developer Documentation
logo: DevDocs
description: Magento 2 Developer Documentation.

# the base protocol and domain
url: https://devdocs.magento.com

# Site theme. https://jekyllrb.com/docs/themes/
theme: devdocs

# Base url that forms 
baseurl: ""

# Parameters for the version switcher. Numeric values must be wraped in quotes.
#
version: "2.3"
versions:
   -
      name: "2.1"
      url: /guides/v2.1/
   -
      name: "2.2"
      url: /guides/v2.2/
   -
      name: "2.3"
      url: /guides/v2.3/

collections:
  videos:
    output: true
    permalink: "/videos/:path/"

# Specific settings for different scopes.
#
defaults:

  -
    scope:
      path: ""
    values:
      lang: en
      layout: default
      github_repo: https://github.com/magento/devdocs/
      github_files: https://github.com/magento/devdocs/blob/master/
      # Enables the 'Edit this page on GitHub' appearences on pages
      github_link: true
      # Enables the 'Give us feedback' appearences on pages
      feedback_link: true
  -
    scope:
      path: guides/m1x
    values:
      layout: null
  -
    scope:
      type: videos
    values:
      layout: video

  - 
    scope:
      path: mbi
    values:
      group: mbi
      github_files: https://github.com/magento/devdocs-mbi/blob/master/
      github_repo: https://github.com/magento/devdocs-mbi/

  -
    scope:
      path: mftf/docs
    values:
      group: mftf
      github_files: https://github.com/magento/magento2-functional-testing-framework/blob/develop/
      github_repo: https://github.com/magento/magento2-functional-testing-framework/
      functional_areas:
        - Test

  - 
    scope:
      path: page-builder
    values:
      group: page-builder
      github_link: false
      feedback_link: false

  - 
      scope:
        path: page-builder-migration
      values:
        group: page-builder
        github_link: false
        feedback_link: false

  -
    scope:
      path: guides/v2.3/mrg
    values:
      group: module-reference-guide-2_3
      github_link: false
      feedback_link: false
  -
    scope:
      path: guides/v2.1
    values:
      sitemap: false
  -
    scope:
      path: guides/v2.2
    values:
      sitemap: false

##########################
# Plugins and extensions #
##########################
#
# For more details about plugins, refer to https://jekyllrb.com/docs/plugins/
# To learn more about particular plugin, find it by name on GitHub.
# This list doesn't include custom plugins.
#
plugins:
  - jekyll-sitemap
  - jekyll-redirect-from
  - jekyll-titles-from-headings
  - jekyll-optional-front-matter
  - jekyll-relative-links

optional_front_matter:
  remove_originals: true

# Configuration options for the jekyll-relative-links plugin. 
# Exclude all .md directories and files except page-builder/ to prevent painfully long build times.

relative_links:
  exclude:
    - _includes
    - _videos
    - codelinks
    - community
    - extensions
    - guides
    - redoc
    - release
    - tmp
    - 404.md
    - availability.md
    - magento-techbull.md
    - magento-third-party.md
    - search
    - system-requirements.md
    - whats-new.md

# Settings for the jekyll-titles-from-headings plugin.
# For more details about the plugin, refer to https://github.com/benbalter/jekyll-titles-from-headings
#
titles_from_headings:
  enabled:     true
  strip_title: true
  collections: false

# kramdown parser settings (extended Markdown to HTML parser). For more details about available options, refer to https://kramdown.gettalong.org/converter/html.html
#
kramdown:
  toc_levels: 2..3
  syntax_highlighter_opts:
    css_class: highlighter
    span:
      line_numbers: false
    block:
      line_numbers: true

# Search engine settings. For more details, refer to https://github.com/algolia/jekyll-algolia
#
algolia:
  application_id: E642SEDTHL
  index_name: devdocs
  api_key: d2d0f33ab73e291ef8d88d8b565e754c
  files_to_exclude:
    - guides/m1x/**/*.html
    - guides/m1x/**/*.md
    - swagger
    - redoc
  # Index HTML elements, especially code samples.
  nodes_to_index: 'p,li,td,code'
  # Override 10KB default and use our allowed max of 20KB
  max_record_size: 20000

google:
  analytics: UA-66243208-1

# Toggles the _plugin/html-check-hook.rb script that checks links in the generated HTML
#
check_links: true

#############
# Variables #
#############
#
# Magento 2 repository variable
mage2bloburl: https://github.com/magento/magento2/blob

# 1.x variables
m1xgdeurl: /guides/m1x
m1xgithuburl: https://github.com/magento/devdocs/blob/master

# 2.1 variables
gdeurl21: /guides/v2.1/
githuburl21: https://github.com/magento/devdocs/tree/master/guides/v2.1/

# 2.2 variables
gdeurl22: /guides/v2.2/
githuburl22: https://github.com/magento/devdocs/tree/master/guides/v2.2/

# 2.3 variables
gdeurl23: /guides/v2.3/
githuburl23: https://github.com/magento/devdocs/tree/master/guides/v2.3/


##########
# Ignore #
##########
#
# The path patterns excluded during site generation
#
exclude:
  - scss
  - bin
  - node_modules
  - vendor
  - .git
  - .idea
  - Gemfile
  - Gemfile.lock
  - package.json
  - package-lock.json
  - Rakefile
  - rakelib
  - README.md
  - _plugins