steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-09-17 14:43:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Removed unnecessary rake command and files

Browse Source 
Improved search documentation
This commit is contained in:
Silvio Giebl
2020-03-25 00:23:17 +01:00
parent 672de29f2e
commit f5e6573e16
6 changed files with 75 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/configuration.md
View File

@@ -37,10 +37,10 @@ logo: "/assets/images/just-the-docs.png"
search_enabled: true
search:
# Split documents into sections that can be individually searched
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of previews to display
# Maximum amount of previews per search result
# Default: 3
previews: 3
# Maximum amount of words to display before a matched word in the preview
@@ -49,12 +49,13 @@ search:
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 10
# Include the relative url in the search
# 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 support for hyphenated search words
# Default: /[\s\-/]+/
tokenizer_separator: /[\s/]+/
# Enable or disable the search button
# Supports true or false (default)
button: true