_config.yml

#Default layout to default :3
defaults:
  - scope:
      path: "" # an empty string here means all files in the project
    values:
      layout: "default"

#------------------------#
# General Stuff          #
#------------------------#

title: Lethal Company Modding
description: Thunderstore Community
theme: just-the-docs
color_scheme: lethal-dark
url: https://lethalcompanymodding.github.io/Thunderstore/
favicon_ico: "/favicon.png"

aux_links:
  Github: https://github.com/LethalCompanyModding/Thunderstore
  Discord: https://discord.gg/lcmod

#------------------------#
# Callouts and Colors    #
#------------------------#

callouts_level: quiet # or loud
callouts:
  important:
    title: Important!
    color: orange
  new:
    title: New!
    color: green
  tip:
    title: Tip!
    color: green
  note:
    title: Notice!
    color: yellow
  license:
    title: "License Information:"
    color: grey-dk
  warning:
    title: Warning!
    color: red

#------------------------#
# Search configuration   #
#------------------------#

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

#------------------------#
# Edit button footer     #
#------------------------#

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit Page"
gh_edit_repository: "https://github.com/LethalCompanyModding/Thunderstore"
gh_edit_branch: "main" # the branch that your docs is served from
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately