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

COM-140 search #61

Open
wants to merge 18 commits into
base: develop
Choose a base branch
from
Open

COM-140 search #61

wants to merge 18 commits into from

Conversation

thomasm0
Copy link
Collaborator

@thomasm0 thomasm0 commented Nov 18, 2024

This PR includes:

  • Algolia search
  • Header changes to introduce search button
  • Basic tests for new (non-swizzled) components
  • GitHub action file to lint and test commits

It doesn't follow our internal design exactly - particularly the search results page, as this would require effectively rewriting the Algolia search + Docusaurus components entirely. I've stuck to a quick + easy solution, as used by many other Docusaurus applications:
https://docsearch.algolia.com/
https://jestjs.io/
https://reactnative.dev/
https://ionicframework.com/docs
https://www.devspace.sh/docs/getting-started/introduction
https://pnpm.io/
https://yew.rs/

@thomasm0 thomasm0 requested a review from a team as a code owner November 18, 2024 14:19

A lot of these simpler options can also be configured through the `Setup / Configuration` page.

**Note the return from `recordExtractor` in line 42 has been edited, changing `lvl1: ['header h1', 'article h1'],` to `lvl1: ['article h1'],` otherwise the indexer will also index the word `Developers` from the global header title.**
Copy link
Collaborator

Choose a reason for hiding this comment

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

space between ** and Note

Copy link
Collaborator

@SireeKoolenWijkstra SireeKoolenWijkstra left a comment

Choose a reason for hiding this comment

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

LGTM, tested it but can't get it to break.

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

Successfully merging this pull request may close these issues.

3 participants