Highlight searchterm in mkdocs #1640
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sphinx has a theme agnostic feature to highlight terms given by the "highlight" GET parameter. This is used by RTD when linking from the search page to the documentation page. This did not work for mkdocs projects yet. We add the logic for this to readthedocs-embed-js in order to make this feature available independently of the used mkdocs theme.
gregmuellegger
force-pushed
the
highlight-searchterm-in-mkdocs
branch
from
ec999b3 to
a28ff54
Compare
|
This probably belongs in mkdocs, not in our codebase. pinging @d0ugal if ya'll want to steal it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sphinx has a theme agnostic feature to highlight terms given by the "highlight" GET parameter. This is used by RTD when linking from the search page to the documentation page.
This did not work for mkdocs projects yet. We add the logic for this to readthedocs-embed-js in order to make this feature available independently of the used mkdocs theme.
This PR is open for discussion. I have a few points in mind that we should discuss:
readthedocs-doc-embed.jsfile the right place to put it? It will increase the filesize just a little with code that is not useful for sphinx builds.Related #1628