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

Troubleshooting Clarification

Browse Source 
Edited this section to clarify and provide more detail.
This commit is contained in:
Jon Griffith
2018-01-31 23:06:39 -07:00
committed by GitHub
parent cd880f75a3
commit 2f5922d01c
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pages/mydoc/mydoc_search_configuration.md
View File

@ -26,7 +26,7 @@ You should exclude any files from search that you don't want appearing in the se
If any formatting in the search.json file is invalid (in the build), search won't work. You'll know that search isn't working if no results appear when you start typing in the search box.
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.)
If this happens, point your browser to your build's search.json file at http://localhost:4000/search.json (or your public github pages site), copy the entire search.json page as it's output on the browser, and then use a [JSON validator](http://jsonlint.com/) to validate the output by pasting what you copied into the validator. Look for the line causing trouble. It will be highlighted. Edit the file that's causing the problem to either exclude it from the search or fix the syntax so that it doesn't invalidate the JSON. (Note that tabs in the body will invalidate JSON, as will certain characters in the file's front matter. For example, the summary: cannot have " quotes in it.
The search.json file already tries to strip out content that would otherwise make the JSON invalid.