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

Add documentation for search configurations

Browse Source
This commit is contained in:
Silvio Giebl
2019-12-29 21:08:15 +01:00
parent ff30552748
commit 2ef0029068
2 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/configuration.md
View File

@@ -36,9 +36,12 @@ logo: "/assets/images/just-the-docs.png"
# Supports true (default) or false
search_enabled: true
# Enable support for hyphenated search words:
search_tokenizer_separator: /[\s/]+/
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
```
## Aux links