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
Enable Algolia Docsearch (documentation search) #1688
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1688 +/- ##
=======================================
Coverage 93.85% 93.85%
=======================================
Files 78 78
Lines 4571 4571
Branches 802 802
=======================================
Hits 4290 4290
Misses 248 248
Partials 33 33 Continue to review full report at Codecov.
|
@@ -185,6 +185,14 @@ const siteConfig = { | |||
|
|||
separateCss: ['static/static', 'static\\static'], | |||
|
|||
algolia: { | |||
apiKey: '46ecd80046d78d4e5d9a5c06f559dfaa', |
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.
Where did this key come from? It feels a little unsafe to include a plaintext API key like this.
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.
@kevinbarabash It is provided by Algolia. It is Search-only API Key, which is safe to use in front-end code and in production. Also, Docusaurus documentation suggests entering the API key to its configuration: https://docusaurus.io/docs/en/search.
The configuration for our DocSearch is available at: https://github.com/algolia/docsearch-configs/blob/master/configs/katex.json. One question is should we include supported functions in |
Not sue. It looks things are set up to use |
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.
Thanks for setting this up. I'm curious to see how well it works with our current docs.
Fixes #1513.