diff --git a/_includes/lunr/custom-data.json b/_includes/lunr/custom-data.json new file mode 100644 index 0000000..e69de29 diff --git a/_includes/lunr/custom-index.js b/_includes/lunr/custom-index.js new file mode 100644 index 0000000..e69de29 diff --git a/assets/js/just-the-docs.js b/assets/js/just-the-docs.js index f243f07..07d4f07 100644 --- a/assets/js/just-the-docs.js +++ b/assets/js/just-the-docs.js @@ -87,6 +87,7 @@ function initSearch() { this.metadataWhitelist = ['position'] for (var i in docs) { + {% include lunr/custom-index.js %} this.add({ id: i, title: docs[i].title, diff --git a/assets/js/zzzz-search-data.json b/assets/js/zzzz-search-data.json index 74dd0ba..370dbe5 100644 --- a/assets/js/zzzz-search-data.json +++ b/assets/js/zzzz-search-data.json @@ -51,6 +51,7 @@ permalink: /assets/js/search-data.json "title": {{ title | jsonify }}, "content": {{ content | replace: ' Customizing search indices is an advanced feature that requires Javascript and Liquid knowledge. + +1. First, ensure that `assets/js/zzzz-search-data.json` is up-to-date; it can be regenerated with `rake` or manually (see: ["Generate search index when used as a gem"](#generate-search-index-when-used-as-a-gem)). +2. To add Liquid/Jekyll-based data: create a new include at the path `_includes/lunr/custom-data.json`. Insert custom Liquid code that reads various data (ex: `include.page`, `site.data`, `site.static_files`) that then generates valid [JSON](https://www.json.org/json-en.html) to add to the index. Verify the fields in the generated `assets/js/search-data.json`. +3. For all custom data (Liquid, JavaScript, or external): create a new include at the path `_includes/lunr/custom-index.js` to your site. Add valid JavaScript that creates relevant fields to add to the index. You may want to inspect `assets/js/just-the-docs.js` to better understand the code structure. **This is necessary to render any relevant custom index code.** + +#### Example + +`_includes/lunr/custom-data.json`: this example adds each page's `usage` and `examples` front matter fields, normalizes the text, and writes the text to custom Javascript `myusage` and `myexamples` fields. + +{% raw %} +```liquid +{%- capture newline %} +{% endcapture -%} +"myusage": {{ include.page.usage | markdownify | replace:newline,' ' | strip_html | normalize_whitespace | strip | jsonify }}, +"myexamples": {{ include.page.examples | markdownify | replace:newline,' ' | strip_html | normalize_whitespace | strip | jsonify }}, +``` +{% endraw %} + +`_includes/lunr/custom-index.js` custom code is within a Javascript loop. All custom +Javascript fields are accessed as fields of `docs[i]` such as `docs[i].myusage`. +Finally, append your custom fields on to the already existing `docs[i].content`. + +```javascript +const content_to_merge = [docs[i].content, docs[i].myusage, docs[i].myexamples]; +docs[i].content = content_to_merge.join(' '); +``` diff --git a/lib/tasks/search.rake b/lib/tasks/search.rake index 55d012a..d1f9fd4 100644 --- a/lib/tasks/search.rake +++ b/lib/tasks/search.rake @@ -61,6 +61,7 @@ permalink: /assets/js/search-data.json "title": {{ title | jsonify }}, "content": {{ content | replace: \'