use mkdocs builtin search.html #2289
Closed
Conversation
This file contains hidden or 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
| @@ -27,7 +27,9 @@ function init() { | |||
| value: 'file' | |||
| }).appendTo('#rtd-search-form'); | |||
|
|
|||
| $("#rtd-search-form").prop("action", rtd.api_host + "/search/"); | |||
| var search_url = window.location.protocol + "//" + window.location.hostname + | |||
| "/" + rtd.language + "/" + rtd.version + "/search.html"; | |||
There was a problem hiding this comment.
This doesn't respect subprojects and aliases. We can't assume the project path is https://hostname/language/version/search.html, it could be https://hostname/projects/subproject/language/version/search.html. Same for aliases here.
|
I'm generally -1 on supporting multiple search UX, and would rather see mkdocs indexing and search fixed using our existing search API. Will need a design decision here. |
benhyland
pushed a commit
to alphagov/paas-developer-docs
that referenced
this pull request
Nov 30, 2016
MkDocs and Readthedocs don't currently agree on how to do search. This means that search has poor UX on the publically deployed docs on readthedocs.io. Here's a workaround suggested in github comments that we could use to fix things for us while we wait for the two projects to reconcile. See: readthedocs/readthedocs.org#2289 readthedocs/readthedocs.org#1088
benhyland
pushed a commit
to alphagov/paas-team-manual
that referenced
this pull request
Nov 30, 2016
MkDocs and Readthedocs don't currently agree on how to do search. This means that search has poor UX on the publically deployed docs on readthedocs.io. Here's a workaround suggested in github comments that we could use to fix things for us while we wait for the two projects to reconcile. See: readthedocs/readthedocs.org#2289 readthedocs/readthedocs.org#1088
|
Closing this, as I don't believe it's currently the solution to the problem of making search better. |
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.
Currently, mkdocs projects have a search-box action of
https://readthedocs.org/search/, which has been reported as inoperative in #1088 (and others). This PR changes this action to use the mkdocs builtinsearch.htmlpage.Also, in the process of making this patch, I found that mkdocs doesn't expose the
mkdocs_page_input_pathvariable on non-content-bearing pages (such assearch.html). Thus, I have placed a guard around it, to prevent it fromReferenceErroring while searching.