_config.yml

version: "202204.0"

repository: spryker/spryker-docs

output: web
# this property is useful for conditional filtering of content that is separate from the PDF.

topnav_title: Spryker Documentation
# this appears on the top navigation bar next to the home button

site_title: Spryker Documentation
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)

company_name: Spryker
# this appears in the footer

github_editme_path: spryker/spryker-docs/blob/master/
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.

google_analytics: "G-CPJX4XMTD1"
# if you have google-analytics ID, put it in. if not, edit this value to blank.

feedback_disable: true

host: 127.0.0.1
# the preview server used. Leave as is.

port: 4000
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.

exclude:
  - .idea/
  - .gitignore
  - .sass-cache/
  - .jekyll-cache/
  - gemfiles/
  - docker-compose.yml
  - Dockerfile
  - Gemfile
  - Gemfile.lock
  - Rakefile
  - static.json
  - node_modules/
  - vendor
  - node_modules
  - package.json
  - package-lock.json
  - gulpfile.js
  - redirect.html
  - docs/scos/dev/drafts-dev/
  - docs/scos/dev/developers-corner/

# these are the files and directories that jekyll will exclude from the build

highlighter: rouge
# library used for syntax highlighting

markdown: CommonMarkGhPages
commonmark:
  options: ["SMART", "FOOTNOTES"]
  extensions: ["strikethrough", "autolink", "table"]

plugins:
  - jekyll-last-modified-at
  - jekyll-include-cache

# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways

defaults:
  -
    scope:
      path: ""
      type: "pages"
    values:
      layout: "page"
      comments: false
      search: true
      topnav: topnav
  -
    scope:
      path: "docs/"
    values:
      feed: true
  -
    scope:
      path: "docs/marketplace"
    values:
      product: "marketplace"
  -
    scope:
      path: "docs/marketplace/dev"
    values:
      sidebar: "marketplace_dev_sidebar"
      role: "dev"
  -
    scope:
      path: "docs/marketplace/user"
    values:
      sidebar: "marketplace_user_sidebar"
      role: "user"
  -
    scope:
      path: "docs/scos"
    values:
      product: "scos"
  -
    scope:
      path: "docs/scos/dev"
    values:
      sidebar: "scos_dev_sidebar"
      role: "dev"
  -
    scope:
      path: "docs/scos/user"
    values:
      sidebar: "scos_user_sidebar"
      role: "user"
  -
    scope:
      path: "docs/cloud"
    values:
      product: "cloud"
  -
    scope:
      path: "docs/cloud/dev"
    values:
      sidebar: "cloud_dev_sidebar"
      role: "dev"
  -
     scope:
       path: "docs/fes"
     values:
       product: "frontend-enablement-service"
  -
     scope:
       path: "docs/fes/dev"
     values:
       sidebar: "fes_dev_sidebar"
       role: "dev"
  -
     scope:
       path: "docs/paas-plus"
     values:
       product: "platform-as-a-service-plus"
  -
     scope:
       path: "docs/paas-plus/dev"
     values:
       sidebar: "paas_plus_dev_sidebar"
       role: "dev"

versions:
  '201811.0': '201811.0'
  '201903.0': '201903.0'
  '201907.0': '201907.0'
  '202001.0': '202001.0'
  '202005.0': 'Code releases 05.20'
  '202009.0': '202009.0'
  '202108.0': '202108.0'
  '202204.0': '202204.0'

# versioned categories - these must match corresponding directories
versioned_categories:
  marketplace:
    user:
      - features
      - back-office-user-guides
      - merchant-portal-user-guides
    dev:
      - feature-integration-guides
      - feature-walkthroughs
      - glue-api-guides
      - data-import
      - data-export
      - legacy-demoshop
  scos:
    user:
      - features
      - back-office-user-guides
      - technology-partners
      - shop-user-guides
    dev:
      - feature-walkthroughs
      - feature-integration-guides
      - data-import
      - data-export
      - glue-api-guides
      - technology-partner-integration-guides
      - the-docker-sdk
      - migration-and-integration
      - legacy-demoshop
      - technology-partner-guides
      - devops-migration-guides

# these are defaults used for the front matter for these file types

sidebars:
  - marketplace_dev_sidebar
  - marketplace_user_sidebar
  - cloud_dev_sidebar
  - scos_dev_sidebar
  - scos_user_sidebar
  - fes_dev_sidebar
  - paas_plus_dev_sidebar

description: "Spryker documentation center."
# the description is used in the feed.xml file

# needed for sitemap.xml file only
# url: http://idratherbewriting.com
# baseurl: /documentation-theme-jekyll


github: [metadata]

search: algolia

algolia:
  application_id: 'IBBSSFT6M1'
  search_only_api_key: '296ac9c40fa95441b2d89d1fd8395bb4'
  max_record_size: 20000
  indices:
    - name: 'scos_user'
      title: 'SCOS User'
    - name: 'scos_dev'
      title: 'SCOS Developer'
    - name: 'marketplace_user'
      title: 'Marketplace User'
    - name: 'marketplace_dev'
      title: 'Marketplace Developer'
    - name: 'cloud_dev'
      title: 'Cloud Developer'
    - name: 'fes_dev'
      title: 'Frontend enablement Service Developer'
    - name: 'paas_plus_dev'
      title: 'Platform as a Service Plus Developer'

sass:
    sass_dir: css
    style: compressed
    sourcemap: never

last-modified-at:
  date-format: '%Y%m%dT%H%M'

redirect_from:
  json: false

form_endpoints:
  feedback: 'https://formspree.io/f/xdoboyro'