New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Search preview shows Markdown source #191
Comments
@jtebert can you paste the contents of your site's |
The problem is, that jekyll processes all files in alphabetical order. So The only solution seems to be to rename the |
I'd forgotten about this issue, but it seems to have been resolved by some update since I created it, so I'm going to close the issue. |
The preview in search results dropdown showed sometimes jekyll includes when it should display text snippets of the results. The problem is when search-data.json is rendered every file after S has not been rendered yet as jekyll processes all files in alphabetical order. In that case the search might display jekyll includes or raw markdown. Renaming search-data.json to zzzz-search-data with a permalink fixes this, see upstream fix. Also removed .json as the file is a template that will render to JSON. just-the-docs#191 (comment)
The preview in search results dropdown showed sometimes jekyll includes when it should display text snippets of the results. The problem is when search-data.json is rendered every file after S has not been rendered yet as jekyll processes all files in alphabetical order. In that case the search might display jekyll includes or raw markdown. Renaming search-data.json to zzzz-search-data with a permalink fixes this, see upstream fix. Also removed .json as the file is a template that will render to JSON. just-the-docs#191 (comment)
Describe the bug
When a search term is found in formatted Markdown text (e.g., a link) the search preview shows the raw Markdown rather than text. This is particularly odd-looking when it includes things like liquid template tags.
To Reproduce
Steps to reproduce the behavior:
Expected behavior
Text should be shown with the tags/formatting stripped (or at least that's how it currently seems to be doing it on this project's documentation).
Screenshots
Desktop (please complete the following information):
Additional notes:
This does not occur on this project's documentation. (Try searching for "quick start guide" as an example). My guess is that the bug comes from the way that the search JSON is being compiled. Updating with
bundle update
didn't solve the problem.The text was updated successfully, but these errors were encountered: