docs: added Algolia search to website #4187
Conversation
|
Thanks for the PR, @JoshuaKGoldberg! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
|
✔️ Deploy Preview for typescript-eslint ready! 🔨 Explore the source changes: 4d59105 🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/619a766a6689420008db0eb0 😎 Browse the preview: https://deploy-preview-4187--typescript-eslint.netlify.app |
| @@ -32,6 +32,7 @@ const config = { | |||
| customCss: require.resolve('./src/css/custom.css'), | |||
| }, | |||
| ], | |||
| '@docusaurus/theme-search-algolia', | |||
There was a problem hiding this comment.
Just a kind notice: we may introduce shorthands in the next (few) release (facebook/docusaurus#5930) like ESLint's eslint-plugin-react -> plugins: ['react']. In that case you may want to put this in themes instead so you can shorten it to themes: ['search-algolia']
packages/website/src/pages/index.tsx
Outdated
| @@ -16,7 +16,8 @@ interface FeatureItem { | |||
|
|
|||
| const features: FeatureItem[] = [ | |||
| { | |||
| title: 'What are ESLint and TypeScript, and how do they compare?', | |||
| title: | |||
| 'Hello world: What are ESLint and TypeScript, and how do they compare?', | |||
There was a problem hiding this comment.
@JamesHenry very odd, I saw the search on my local deployment from the commit in the PR:
Now, with this Hello World: change, I see it on the Netlify deployment too:
🤷
There was a problem hiding this comment.
Might be related to caching... I can't pinpoint it either
|
Just checked the preview deployment and it's all working for me! Great work! |
PR Checklist
Overview
Follows https://docusaurus.io/docs/search#using-algolia-docsearch to get Algolia search on the site. 🔍
In my usage this doesn't change the website right now -no header search bar or✔️/searchpage-, so keeping in draft... I don't know why it's not showing locally. The steps in facebook/docusaurus#4975, run in both the repo root and thepackages/websitedirectory aren't fixing it, and I don't see any obvious typos or missing packages.