HPCE/gitea-pages
0
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Activity

fixed github edit me links. also added doc for using variables with include parameters for notes, callouts, etc.

Browse Source
This commit is contained in:
tomjohnson1492
2016-06-16 15:20:34 -07:00
parent 6653e1a846
commit f55c60e4d1
92 changed files with 442 additions and 394 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
mydoc/mydoc_search_configuration.md
View File

@ -6,6 +6,7 @@ last_updated: March 20, 2016
summary: "The search feature uses JavaScript to look for keyword matches in a JSON file. The results show instant matches, but it doesn't provide a search results page like Google. Also, sometimes invalid formatting can break the JSON file."
sidebar: mydoc_sidebar
permalink: /mydoc_search_configuration/
folder: mydoc
---
## About search
@ -27,9 +28,9 @@ If any formatting in the search.json file is invalid (in the build), search won'
If this happens, go directly to the search.json file in your browser, and then copy the content. Go to a [JSON validator](http://jsonlint.com/) and paste in the content. Look for the line causing trouble. Edit the file to either exclude the page from search or fix the syntax so that it doesn't invalidate the JSON. (Note that tabs in the body will invalidate JSON.)
The search.json file already tries to strip out content that would otherwise make the JSON invalid.
The search.json file already tries to strip out content that would otherwise make the JSON invalid.
## Including the body field in search
## Including the body field in search
I've found that include the `body` field in the search creates too many problems, and so I've removed `body` from the search. You can see the results of including the `body` by adding this along with the other fields in search.json:
{% raw %}
@ -108,8 +109,8 @@ The \_includes/topnav.html file then makes use of these values:
</li>
```
Where you see `{url}` and `{title}`, the search is retrieving the values for these as specified in the search.json file.
Where you see `{url}` and `{title}`, the search is retrieving the values for these as specified in the search.json file.
## More robust search
For more robust search, consider integrating either [Algolia](http://algolia.com) or [Swifttype](http://swiftype.com).
For more robust search, consider integrating either [Algolia](http://algolia.com) or [Swifttype](http://swiftype.com).