Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Algolia DocSearch #1055

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Implement Algolia DocSearch #1055

wants to merge 4 commits into from

Conversation

johndmulhausen
Copy link
Contributor

Ideally we can get it so where it has breadcrumbs and context snippets instead of this:
image

@johndmulhausen johndmulhausen requested a review from a team as a code owner January 31, 2025 20:57
Copy link

cloudflare-workers-and-pages bot commented Jan 31, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: b941911
Status: ✅  Deploy successful!
Preview URL: https://0b4ee8b5.docodile.pages.dev
Branch Preview URL: https://docsearch.docodile.pages.dev

View logs

@mdlinville
Copy link
Contributor

Screenshot 2025-01-31 at 1 41 10 PM

I wonder if it is possible to disable having each heading (in the same file) show up as a separate search result. Overall, this seems better than the situation with Algolia before.

# indexName: docodile
search:
algolia:
appId: 6HH47A49YJ
Copy link
Contributor

@ngrayluna ngrayluna Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be hiding our API keys? E.g. in a .env or .gitignore? (apiKey)

Copy link
Contributor Author

@johndmulhausen johndmulhausen Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We never did before; I think it's fine, that's the pattern you use for things like GTM as well, and this is the documented way Docsy says to specify your appId

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our repo was private before ;)

hugo.yaml Outdated Show resolved Hide resolved
@ngrayluna
Copy link
Contributor

ngrayluna commented Jan 31, 2025

Some maybe useful pages within the Algolia account app?

Searchable attributes:
Search -> Index -> Configuration
Screenshot 2025-01-31 at 2 05 37 PM

UI return results demo. Could be useful for seeing what it takes to generate bread crumbs...
Search -> Index -> UI Demos -> Generate UI Demos -> Generate a new demo -> Instant Search

It would seem that based on the Configuration, that you can demo the results...how that then translates back to the site is not entirely clear...
Screenshot 2025-01-31 at 2 08 51 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants