Add search capabilities to ghostty.org

[shortcuts]

(Initially proposed in ghostty-org/website#137, see POC), kind of similar discussion: #3022

---

I was browsing the docs for shell integrations with fish and realized there was no search capabilities, and was wondering if the team already had solutions in mind for future implementations.

While the project has only been public for a few hours, and might not be indexed by global search engines yet, having a searchable documentation from the website provides a great user experience.

Proposal

Obviously I'm biased here because I work at Algolia and I'm one of the main contributor of DocSearch (repository) but I like to help setting up search instances for tools that I use, so here's a small POC for Ghostty:

Desktop	Mobile

You can also browse the live preview here: https://website-git-fork-shortcuts-main-ghostty.vercel.app/docs

Disclaimer: The API key is search-only and public, no worries about disclosing it in the POC. I also did not managed to match the website fonts

Infrastructure costs

DocSearch is free for open-source projects, no additional costs on your side.

Maintenance costs

I can help finishing the POC and improving the indexing logic/search relevancy based on your expectations.

[Kerollmops]

Hey 👋

I recommend using Meilisearch. It's also open source 😉 You can probably follow what Tauri is doing.

Note, I am the co-founder 😉

[annesnour03]

Hey 👋

I recommend using Meilisearch. It's also open source 😉 You can probably follow what Tauri is doing.

I think it's appropriate if you note that you're one of the co-founders 😃

[Fluf22]

I'm siding with Clément on this one

[BrandonRomano]

I am generally in favor of an Algolia based approach; largely is as I am familiar with it and know it will solve for our use case. The fact that there are no costs to OSS projects seems pretty great to me.

My vote here is not authoritative; but I wanted to share where I am leaning. Others should still weigh in here if there are any opinions.

@shortcuts thanks for opening this discussion with the POC 👏

[goproslowyo]

It'd be neat to revisit the ghostty-org/website#137 PR that @shortcuts opened if Algolia is the one. It'd be nice to get something since ease of finding things like config options, other docs, release notes, etc is one of the things new people have been having a hard time with.

It's a quick win and it'd help a great deal of newcomers out and will only get better as PRs to improve the docs on the website are merged.

It's also top 10 in the ideas/issue triage discussions :)

[aretrace]

How about something simpler like Pagefind