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

Add configuration option search_tokenizer_separator

Browse Source 
The default is for hyphens to separate tokens in search terms: `gem-based` is equivalent to `gem based`.

This adds `search_tokenizer_separator` as a site configuation option, to support search for hyphenated words.
This commit is contained in:
Peter Mosses 2019-08-29 15:36:13 +02:00
parent ed492bf40e
commit 50cdf076b4
3 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
_config.yml
View File

@ -24,6 +24,11 @@ exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "pac
# Enable or disable the site search # Enable or disable the site search
search_enabled: true search_enabled: true
# Set the search token separator
search_tokenizer_separator: /[\s\-/]+/
# For hyphenated-word search:
# search_tokenizer_separator: /[\s/]+/
# Enable or disable heading anchors # Enable or disable heading anchors
heading_anchors: true heading_anchors: true

2
assets/js/just-the-docs.js
View File

@ -53,7 +53,7 @@ function initSearch() {
// Success! // Success!
var data = JSON.parse(request.responseText); var data = JSON.parse(request.responseText);
lunr.tokenizer.separator = /[\s\-/]+/ lunr.tokenizer.separator = {{ site.search_tokenizer_separator }}
var index = lunr(function () { var index = lunr(function () {
this.ref('id'); this.ref('id');
this.field('title', { boost: 200 }); this.field('title', { boost: 200 });

9
docs/search.md
View File

@ -59,6 +59,15 @@ In your site's `_config.yml`, enable search:
search_enabled: true search_enabled: true
``` ```
The default is for hyphens to separate tokens in search terms:
`gem-based` is equivalent to `gem based`, matching either word.
To allow search for hyphenated words:
```yaml
# Set the search token separator
search_tokenizer_separator: /[\s/]+/
```
## Hiding pages from search ## Hiding pages from search
Sometimes you might have a page that you don't want to be indexed for the search nor to show up in search results, e.g, a 404 page. To exclude a page from search, add the `search_exclude: true` parameter to the page's YAML front matter: Sometimes you might have a page that you don't want to be indexed for the search nor to show up in search results, e.g, a 404 page. To exclude a page from search, add the `search_exclude: true` parameter to the page's YAML front matter: