docs(html): algolia docsearch #23839
Merged
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
justinmk
force-pushed
the
docsearch
branch
2 times, most recently
from
a3ef529
to
088fa42
Compare
Need to manually include this in the generated docs html because it doesn't use the website's (jekyll) layout template. Maintenance notes: https://github.com/neovim/neovim.github.io/#maintenance Related: neovim/neovim.github.io@ce9aef1
justinmk
added a commit
to justinmk/neovim
that referenced
this pull request
Jun 2, 2023
Problem: Selecting a search result from the Algolia Docsearch widget does not navigate to a page anchor. The docs HTML provides `<a name=…>` anchors _near_ the `<h1>`/`<h2>`/… headings, but Algolia Docsearch expects the anchors to be _defined on_ the headings. That's also "semantically" nicer. https://docsearch.algolia.com/docs/manage-your-crawls/ Solution: Set `id` on the heading element instead of placing `<a name=…>` nearby. related: 3913ebb neovim#23839
justinmk
added a commit
that referenced
this pull request
Jun 2, 2023
Problem: Selecting a search result from the Algolia Docsearch widget does not navigate to a page anchor. The docs HTML provides `<a name=…>` anchors _near_ the `<h1>`/`<h2>`/… headings, but Algolia Docsearch expects the anchors to be _defined on_ the headings. That's also "semantically" nicer. https://docsearch.algolia.com/docs/manage-your-crawls/ Solution: Set `id` on the heading element instead of placing `<a name=…>` nearby. related: 3913ebb #23839
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.
Need to manually include this in the generated docs html because it doesn't use the website's jekyll layout.
neovim/neovim.github.io@ce9aef1
Maintenance notes for docsearch are mentioned at:
https://github.com/neovim/neovim.github.io/#maintenance