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

Merge branch 'feature/search-sections' into improvement/navigation-new

Browse Source 
# Conflicts:
#	_includes/nav.html
#	_layouts/default.html
#	assets/js/search-data.json
#	docs/configuration.md
#	lib/tasks/search.rake
This commit is contained in:
Silvio Giebl
2020-06-15 22:06:16 +02:00
parent 18f3a41600 16628f2b8e
commit 51f15965f2
17 changed files with 732 additions and 384 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/configuration.md
View File

@@ -36,8 +36,29 @@ 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:
# 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: false
# Enable or disable the search button
# Supports true or false (default)
button: true
```
## Aux links