-
Notifications
You must be signed in to change notification settings - Fork 13.4k
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
feat: Implements Docusearch into docusaurus docs #19289
Conversation
@@ -159,6 +157,11 @@ const config = { | |||
defaultMode: 'light', | |||
disableSwitch: true, | |||
}, | |||
algolia: { | |||
appId: 'WR5FASX5ED', | |||
apiKey: '299e4601d2fc5d0031bf9a0223c7f0c5', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://docusaurus.io/docs/search
Says that it is safe to commit this, which feels weird.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is there a way for us to embedded these keys via the env? Personally don't think it is a good idea to just have these available for someone to just copy
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @villebro
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is ok, as I believe this is just a reference to the search index (this can probably be extracted fairly easily from the built assets, too)
@@ -17,6 +17,7 @@ | |||
}, | |||
"dependencies": { | |||
"@ant-design/icons": "^4.7.0", | |||
"@docsearch/react": "^3.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needed for docuSearch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
(cherry picked from commit 6083545)
SUMMARY
This PR implements docusearch in our current docusaurus documentation. It uses algolia to do so.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION