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

Added search.button configuration

Browse Source 
Improved documentation for search configurations
This commit is contained in:
Silvio Giebl
2019-12-29 21:30:44 +01:00
parent 2ef0029068
commit 82b3f15443
5 changed files with 43 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/configuration.md
View File

@@ -37,11 +37,24 @@ logo: "/assets/images/just-the-docs.png"
search_enabled: true
search:
heading_level: 2 # Split documents into sections that can be individually searched
preview_words_before: 5 # Maximum amount of words to display before a matched word in the preview
preview_words_after: 10 # Maximum amount of words to display after a matched word in the preview
rel_url: false # Include the relative url in the search: true (default) or false
tokenizer_separator: /[\s/]+/ # Enable support for hyphenated search words
# Split documents into sections that can be individually searched
# Supports 1 - 6, default: 2
heading_level: 2
# 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
# Include the relative url in the search
# 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
```
## Aux links