_config.yml - gluten-site - Git at Google

 # Welcome to Jekyll!
 #
 # This config file is meant for settings that affect your whole blog, values
 # which you are expected to set up once and rarely edit after that. If you find
 # yourself editing this file very often, consider using Jekyll's data files
 # feature for the data you need to update frequently.
 #
 # For technical reasons, this file is *NOT* reloaded automatically when you use
 # 'bundle exec jekyll serve'. If you change this file, please restart the server process.
 #
 # If you need help with YAML syntax, here are some quick references for you:
 # https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
 # https://learnxinyminutes.com/docs/yaml/
 #
 # Site settings
 # These are used to personalize your new site. If you look in the HTML files,
 # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.

 title: Apache Gluten
 email: weitingchen@apache.org
 description:  "Gluten is a middle layer responsible for offloading JVM-based SQL engines' execution to native engines."
 baseurl: "/" # the subpath of your site, e.g. /blog
 domain: apache.org
 url: "https://gluten.apache.org" # the base hostname & protocol for your site, e.g. http://example.com
 twitter_username: jekyllrb
 github_username:  jekyll

 # Build settings
 #theme: jekyll-theme-minimal
 #remote_theme: pmarsceill/just-the-docs
 #theme: just-the-docs
 remote_theme: just-the-docs/just-the-docs
 plugins:
   - jekyll-feed
   - jekyll-optional-front-matter # GitHub Pages
   - jekyll-default-layout        # GitHub Pages
   - jekyll-titles-from-headings  # GitHub Pages
   - jekyll-readme-index          # GitHub Pages
   - jekyll-relative-links        # GitHub Pages

 logo: "/assets/images/gluten-logo-blue.png"

 # Exclude from processing.
 # The following items will not be processed, by default.
 # Any item listed under the `exclude:` key here will be automatically added to
 # the internal "default list".
 #
 # Excluded items can be processed by explicitly listing the directories or
 # their entries' file path in the `include:` list.
 #
 # exclude:
 #   - .sass-cache/
 #   - .jekyll-cache/
 #   - gemfiles/
 #   - Gemfile
 #   - Gemfile.lock
 #   - node_modules/
 #   - vendor/bundle/
 #   - vendor/cache/
 #   - vendor/gems/
 #   - vendor/ruby/

 # Enable or disable the site search
 # Supports true (default) or false
 search_enabled: true

 search:
   # Split pages into sections that can be searched individually
   # Supports 1 - 6, default: 2
   heading_level: 2
   # Maximum amount of previews per search result
   # Default: 3
   previews: 3
   # Maximum amount of words to display before a matched word in the preview
   # Default: 5
   preview_words_before: 5
   # Maximum amount of words to display after a matched word in the preview
   # Default: 10
   preview_words_after: 10
   # Set the search token separator
   # Default: /[\s\-/]+/
   # Example: enable support for hyphenated search words
   tokenizer_separator: /[\s/]+/
   # Display the relative url in search results
   # Supports true (default) or false
   rel_url: true
   # Enable or disable the search button that appears in the bottom right corner of every page
   # Supports true or false (default)
   button: false

   #mermaid:
   # Version of mermaid library
   # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
   #version: "11.2.0"
   #path: "/assets/js/mermaid.esm.min.mjs"

 # Aux links for the upper right navigation
 aux_links:
   "Apache Gluten Github":
     - "//github.com/apache/gluten"

 # Makes Aux links open in a new tab. Default is false
 aux_links_new_tab: true

 # Enable or disable the side/mobile menu globally
 # Nav menu can also be selectively enabled or disabled using page variables or the minimal layout
 nav_enabled: true

 # Sort order for navigation links
 # nav_sort: case_insensitive # default, equivalent to nil
 nav_sort: case_sensitive # Capital letters sorted before lowercase

 # Heading anchor links appear on hover over h1-h6 tags in page content
 # allowing users to deep link to a particular heading on a page.
 #
 # Supports true (default) or false
 heading_anchors: true

 # External navigation links
 #nav_external_links:
 #  - title: Documentations_Latest
 #    url: https://apache.github.io/gluten/
 #    hide_icon: false # set to true to hide the external link icon - defaults to false
 #    opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false


 color_scheme: light

 # Footer content
 # appears at the bottom of every page's main content
 # Note: The footer_content option is deprecated and will be removed in a future major release. Please use `_includes/footer_custom.html` for more robust markup / liquid-based content.
 #footer_content: "Apache Gluten is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF."
 #footer_content: "Copyright &copy; 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a>"
 # Back to top link
 back_to_top: true
 back_to_top_text: "Back to top"

 footer_content: ""

 # Footer last edited timestamp
 last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
 last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html

 # Footer "Edit this page on GitHub" link text
 gh_edit_link: false # show or hide edit this page link
 gh_edit_link_text: "Edit this page on GitHub."
 gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
 gh_edit_branch: "main" # the branch that your docs is served from
 # gh_edit_source: docs # the source that your files originate from
 gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

 collections:
   docs:
     output: true

 just_the_docs:
   collections:
     docs:
       name: Documentations
       nav_fold: true
	# Welcome to Jekyll!
	#
	# This config file is meant for settings that affect your whole blog, values
	# which you are expected to set up once and rarely edit after that. If you find
	# yourself editing this file very often, consider using Jekyll's data files
	# feature for the data you need to update frequently.
	#
	# For technical reasons, this file is NOT reloaded automatically when you use
	# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
	#
	# If you need help with YAML syntax, here are some quick references for you:
	# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
	# https://learnxinyminutes.com/docs/yaml/
	#
	# Site settings
	# These are used to personalize your new site. If you look in the HTML files,
	# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
	# You can create any custom variable you would like, and they will be accessible
	# in the templates via {{ site.myvariable }}.

	title: Apache Gluten
	email: weitingchen@apache.org
	description: "Gluten is a middle layer responsible for offloading JVM-based SQL engines' execution to native engines."
	baseurl: "/" # the subpath of your site, e.g. /blog
	domain: apache.org
	url: "https://gluten.apache.org" # the base hostname & protocol for your site, e.g. http://example.com
	twitter_username: jekyllrb
	github_username: jekyll

	# Build settings
	#theme: jekyll-theme-minimal
	#remote_theme: pmarsceill/just-the-docs
	#theme: just-the-docs
	remote_theme: just-the-docs/just-the-docs
	plugins:
	- jekyll-feed
	- jekyll-optional-front-matter # GitHub Pages
	- jekyll-default-layout # GitHub Pages
	- jekyll-titles-from-headings # GitHub Pages
	- jekyll-readme-index # GitHub Pages
	- jekyll-relative-links # GitHub Pages

	logo: "/assets/images/gluten-logo-blue.png"

	# Exclude from processing.
	# The following items will not be processed, by default.
	# Any item listed under the `exclude:` key here will be automatically added to
	# the internal "default list".
	#
	# Excluded items can be processed by explicitly listing the directories or
	# their entries' file path in the `include:` list.
	#
	# exclude:
	# - .sass-cache/
	# - .jekyll-cache/
	# - gemfiles/
	# - Gemfile
	# - Gemfile.lock
	# - node_modules/
	# - vendor/bundle/
	# - vendor/cache/
	# - vendor/gems/
	# - vendor/ruby/

	# Enable or disable the site search
	# Supports true (default) or false
	search_enabled: true

	search:
	# Split pages into sections that can be searched individually
	# Supports 1 - 6, default: 2
	heading_level: 2
	# Maximum amount of previews per search result
	# Default: 3
	previews: 3
	# Maximum amount of words to display before a matched word in the preview
	# Default: 5
	preview_words_before: 5
	# Maximum amount of words to display after a matched word in the preview
	# Default: 10
	preview_words_after: 10
	# Set the search token separator
	# Default: /[\s\-/]+/
	# Example: enable support for hyphenated search words
	tokenizer_separator: /[\s/]+/
	# Display the relative url in search results
	# Supports true (default) or false
	rel_url: true
	# Enable or disable the search button that appears in the bottom right corner of every page
	# Supports true or false (default)
	button: false

	#mermaid:
	# Version of mermaid library
	# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
	#version: "11.2.0"
	#path: "/assets/js/mermaid.esm.min.mjs"

	# Aux links for the upper right navigation
	aux_links:
	"Apache Gluten Github":
	- "//github.com/apache/gluten"

	# Makes Aux links open in a new tab. Default is false
	aux_links_new_tab: true

	# Enable or disable the side/mobile menu globally
	# Nav menu can also be selectively enabled or disabled using page variables or the minimal layout
	nav_enabled: true

	# Sort order for navigation links
	# nav_sort: case_insensitive # default, equivalent to nil
	nav_sort: case_sensitive # Capital letters sorted before lowercase

	# Heading anchor links appear on hover over h1-h6 tags in page content
	# allowing users to deep link to a particular heading on a page.
	#
	# Supports true (default) or false
	heading_anchors: true

	# External navigation links
	#nav_external_links:
	# - title: Documentations_Latest
	# url: https://apache.github.io/gluten/
	# hide_icon: false # set to true to hide the external link icon - defaults to false
	# opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false


	color_scheme: light

	# Footer content
	# appears at the bottom of every page's main content
	# Note: The footer_content option is deprecated and will be removed in a future major release. Please use `_includes/footer_custom.html` for more robust markup / liquid-based content.
	#footer_content: "Apache Gluten is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF."
	#footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a>"
	# Back to top link
	back_to_top: true
	back_to_top_text: "Back to top"

	footer_content: ""

	# Footer last edited timestamp
	last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
	last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html

	# Footer "Edit this page on GitHub" link text
	gh_edit_link: false # show or hide edit this page link
	gh_edit_link_text: "Edit this page on GitHub."
	gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
	gh_edit_branch: "main" # the branch that your docs is served from
	# gh_edit_source: docs # the source that your files originate from
	gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

	collections:
	docs:
	output: true

	just_the_docs:
	collections:
	docs:
	name: Documentations
	nav_fold: true