_config.yml

remote_theme: just-the-docs/just-the-docs
plugins:
  - jekyll-remote-theme
exclude: ["Gemfile", "Gemfile.lock", "LICENSE", "CONTRIBUTING.md", "README.md",]

title: Stash-Docs
tagline: Documentation for Stash software
description: Stash software documentation from how to get started to advanced tutorials. 
domain: docs.stashapp.cc
url: "docs.stashapp.cc"

permalink: pretty

# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/logo_v4.png"
#logo: https://stashapp.cc/images/stash.svg

# Aux links for the upper right navigation
aux_links:
  "Donate @ Open Collective":
    - "https://opencollective.com/stashapp"
aux_links_new_tab: true

# External navigation links
nav_external_links:
  - title: Community Discord
    url: https://discord.gg/frQ7qBvB3S
  - title: Contributing to Stash-Docs
    url: https://github.com/stashapp/Stash-Docs#contributing

# Footer content
# appears at the bottom of every page's main content

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub"
gh_edit_repository: "https://github.com/stashapp/Stash-Docs" # the github URL for your repo
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

search_enabled: true

search:
  # Split pages into sections that can be searched individually
  # Supports 1 - 6, default: 2
  heading_level: 3
  # 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: false
  # Enable or disable the search button that appears in the bottom right corner of every page
  # Supports true or false (default)
  button: true

# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
color_scheme: stashdb-dark

callouts_level: loud
callouts:
  warning:
    title: Warning
    color: red
  note:
    title: Note
    color: yellow 
  new:
    title: New
    color: green
  important:
    title: Important
    color: blue 

kramdown:
  syntax_highlighter_opts:
    block:
      line_numbers: false