_config.yml

title: Featurebase help
description: FeatureBase enables data engineers to process and operate on massive, continuously changing datasets in real time.
theme: just-the-docs

# WARNING: Do not change these settings without good reason to avoid breaking things
# config.yml is heavily customized and will NOT update with changes from the source Just-the-docs repo
# This means we need to check updates to the repo from time to time (so we can get things like copy button on code blocks, etc)

url: https://github.com/FeatureBaseDB/featurebase-docs
# remote_theme: "pmarsceill/just-the-docs"
# url: https://just-the-docs.github.io

# External navigation links appear in the sidebar navigation right at the bottom
#nav_external_links:
#  - title: Just the Docs on GitHub
#    url: https://github.com/just-the-docs/just-the-docs
#    hide_icon: false # set to true to hide the external link icon - defaults to false

# Exclude folders from build
exclude:
  - help-on-help
  - node_modules
  - old-backup

# Top of page nav
  # Makes Aux links open in a new tab. Default is false
aux_links_new_tab: true
  # Anchor text and hyperlinks that appear in top of page nav
aux_links:
  Home: https://featurebase.com
  FAQ: /docs/cloud/cloud-faq/cloud-faq-home
  API: https://api-docs-featurebase-cloud.redoc.ly/
  SQL: /docs/sql-guide/sql-guide-home
  Status: https://status.featurebase.com/
  Support: https://featurebase.com/slack

# permalink info found on https://jekyllrb.com/docs/permalinks/
# WARNING: SITE LINKS WILL BREAK IF THIS IS CHANGED FROM `pretty`
permalink: pretty

# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/images/FeatureBase-Logo-Gradient-Wide.png"

color_scheme: featurebase # file URL: /_sass/color_schemes/featurebase.css
# Enable or disable the site search
# Supports true (default) or false
search_enabled: true

# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
search.heading_level: 2

# Maximum amount of previews per search result
# Default: 3
search.previews: 10

# Maximum amount of words to display before a matched word in the preview
# Default: 5
search.preview_words_before: 5

# Maximum amount of words to display after a matched word in the preview
# Default: 10
search.preview_words_after: 10

# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
search.button: true

# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator: /[\s/]+/

# For copy button on code
enable_copy_code_button: true

# Text highlighting callouts

  # Colours found in /_sass/color_schemes for red, green, purple. other colors are theme defaults

callouts_level: loud # or quiet
callouts:
  highlight:
    color: yellow
  important:
    title: Important
    color: blue
  success:
    title: Success
    color: green
  note:
    title: Note
    color: purple
  warning:
    title: Warning
    color: red
  tip:
    title: Tip
    color: green