feat: add DocSearch integration#378
Draft
phanan wants to merge 1 commit into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
|
@BrandonRomano @mitchellh Sorry for the ping, but do you think this is worth pursuing or should I just close it? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
@BrandonRomano @mitchellh What do you think about an integration with Algolia DocSearch? AFAIK it's pretty much a standard nowadays when it comes to documentation searching, something Ghostty can benefit from, so I'm giving it a try. It looks like this currently:
Desktop:
(Ignore the weird Cmd key style, it's because I pressed Cmd for the screenshot, which triggers the
:activestate of the element).Mobile:
There's no index yet, as Algolia requires domain verification to enable their crawler. If greenlit, I'll host a version of Ghostty doc publicly and make sure the search result styling matches that of our brand.
Thoughts?