Skip to content

Commit

Permalink
added assests folder and lines in config
Browse files Browse the repository at this point in the history
  • Loading branch information
balotofi committed Oct 26, 2024
1 parent ac05253 commit ad5fb20
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,39 @@ theme: just-the-docs

url: https://birdsopensource.github.io/docs/

# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/images/birds-logo-light.png"

# Set a path/url to a favicon that will be displayed by the browser
favicon_ico: "/assets/images/favicon.ico"

# 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
# Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
focus_shortcut_key: 'k'

0 comments on commit ad5fb20

Please sign in to comment.