Skip to content
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

Documentation search results should parse and display markdown #2246

Closed
1 task done
zleonov opened this issue Aug 11, 2023 · 0 comments · Fixed by #2248
Closed
1 task done

Documentation search results should parse and display markdown #2246

zleonov opened this issue Aug 11, 2023 · 0 comments · Fixed by #2248
Milestone

Comments

@zleonov
Copy link

zleonov commented Aug 11, 2023

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

I have a schema which contains robust documentation:
altair_docs

When I search the documentation 2 things happen:

At first, while the cursor is still positioned in the textbox (I guess it's doing a live search) I see this:
altair_docs_search

Then when I click way from the search box, I see this:
altair_docs_search_after

Expected Behavior

I think I would expect the search results would look identical to the way the documentation is rendered with the markdown parsed. And ideally the search terms would be highlighted in each result.

Steps To Reproduce

Load a schema which has markdown documentation.
Search for a term.

Environment

Win10. Desktop client version 5.1.0

Additional context

No response

@imolorhe imolorhe mentioned this issue Aug 12, 2023
3 tasks
@imolorhe imolorhe added this to the v5.1.1 milestone Aug 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants