Skip to content

Commit

Permalink
docs: added Algolia search to website (#4187)
Browse files Browse the repository at this point in the history 
* feat: added Algolia search to website

* fix: actually use the algolia theme

* Testing hello world feature

* Remove hello world
  • Loading branch information
Josh Goldberg committed Nov 23, 2021
1 parent 637722a commit 46a9aee
Show file tree
Hide file tree
Showing 3 changed files with 193 additions and 1 deletion.
7 changes: 6 additions & 1 deletion packages/website/docusaurus.config.js
View file
Expand Up @@ -32,6 +32,7 @@ const config = {
customCss: require.resolve('./src/css/custom.css'),
},
],
'@docusaurus/theme-search-algolia',
[
'@docusaurus/plugin-content-pages',
{
Expand Down Expand Up @@ -67,7 +68,11 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/theme-common').UserThemeConfig} */
({
// sidebarCollapsible: false,
algolia: {
appId: 'BH4D9OD16A',
apiKey: '1ad6b47d4e742c4c0653877b5511c602',
indexName: 'typescript-eslint',
},
metadatas: [
{ name: 'msapplication-TileColor', content: '#443fd4' },
{ name: 'theme-color', content: '#443fd4' },
Expand Down
1 change: 1 addition & 0 deletions packages/website/package.json
View file
Expand Up @@ -18,6 +18,7 @@
"@docusaurus/plugin-debug": "^2.0.0-beta.9",
"@docusaurus/remark-plugin-npm2yarn": "^2.0.0-beta.9",
"@docusaurus/theme-classic": "^2.0.0-beta.9",
"@docusaurus/theme-search-algolia": "^2.0.0-beta.9",
"@mdx-js/react": "1.6.22",
"@typescript-eslint/eslint-plugin": "5.4.0",
"@typescript-eslint/parser": "5.4.0",
Expand Down
186 changes: 186 additions & 0 deletions yarn.lock
View file
Expand Up @@ -2,6 +2,129 @@
# yarn lockfile v1


"@algolia/autocomplete-core@1.2.2":
version "1.2.2"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.2.2.tgz#c121e70c78fd0175c989a219918124ad7758e48b"
integrity sha512-JOQaURze45qVa8OOFDh+ozj2a/ObSRsVyz6Zd0aiBeej+RSTqrr1hDVpGNbbXYLW26G5ujuc9QIdH+rBHn95nw==
dependencies:
"@algolia/autocomplete-shared" "1.2.2"

"@algolia/autocomplete-preset-algolia@1.2.2":
version "1.2.2"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.2.2.tgz#da734ef9e42a5f64cdad2dfc81c4e9fbf805d976"
integrity sha512-AZkh+bAMaJDzMZTelFOXJTJqkp5VPGH8W3n0B+Ggce7DdozlMRsDLguKTCQAkZ0dJ1EbBPyFL5ztL/JImB137Q==
dependencies:
"@algolia/autocomplete-shared" "1.2.2"

"@algolia/autocomplete-shared@1.2.2":
version "1.2.2"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.2.2.tgz#ff25dc308f2a296b2b9b325f1e3b57498eea3e0c"
integrity sha512-mLTl7d2C1xVVazHt/bqh9EE/u2lbp5YOxLDdcjILXmUqOs5HH1D4SuySblXaQG1uf28FhTqMGp35qE5wJQnqAw==

"@algolia/cache-browser-local-storage@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.11.0.tgz#1c168add00b398a860db6c86039e33b2843a9425"
integrity sha512-4sr9vHIG1fVA9dONagdzhsI/6M5mjs/qOe2xUP0yBmwsTsuwiZq3+Xu6D3dsxsuFetcJgC6ydQoCW8b7fDJHYQ==
dependencies:
"@algolia/cache-common" "4.11.0"

"@algolia/cache-common@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/cache-common/-/cache-common-4.11.0.tgz#066fe6d58b18e4b028dbef9bb8de07c5e22a3594"
integrity sha512-lODcJRuPXqf+6mp0h6bOxPMlbNoyn3VfjBVcQh70EDP0/xExZbkpecgHyyZK4kWg+evu+mmgvTK3GVHnet/xKw==

"@algolia/cache-in-memory@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/cache-in-memory/-/cache-in-memory-4.11.0.tgz#763c8cb655e6fd2261588e04214fca0959ac07c1"
integrity sha512-aBz+stMSTBOBaBEQ43zJXz2DnwS7fL6dR0e2myehAgtfAWlWwLDHruc/98VOy1ZAcBk1blE2LCU02bT5HekGxQ==
dependencies:
"@algolia/cache-common" "4.11.0"

"@algolia/client-account@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/client-account/-/client-account-4.11.0.tgz#67fadd3b0802b013ebaaa4b47bb7babae892374e"
integrity sha512-jwmFBoUSzoMwMqgD3PmzFJV/d19p1RJXB6C1ADz4ju4mU7rkaQLtqyZroQpheLoU5s5Tilmn/T8/0U2XLoJCRQ==
dependencies:
"@algolia/client-common" "4.11.0"
"@algolia/client-search" "4.11.0"
"@algolia/transporter" "4.11.0"

"@algolia/client-analytics@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-4.11.0.tgz#cbdc8128205e2da749cafc79e54708d14c413974"
integrity sha512-v5U9585aeEdYml7JqggHAj3E5CQ+jPwGVztPVhakBk8H/cmLyPS2g8wvmIbaEZCHmWn4TqFj3EBHVYxAl36fSA==
dependencies:
"@algolia/client-common" "4.11.0"
"@algolia/client-search" "4.11.0"
"@algolia/requester-common" "4.11.0"
"@algolia/transporter" "4.11.0"

"@algolia/client-common@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-4.11.0.tgz#9a2d1f6f8eaad25ba5d6d4ce307ba5bd84e6f999"
integrity sha512-Qy+F+TZq12kc7tgfC+FM3RvYH/Ati7sUiUv/LkvlxFwNwNPwWGoZO81AzVSareXT/ksDDrabD4mHbdTbBPTRmQ==
dependencies:
"@algolia/requester-common" "4.11.0"
"@algolia/transporter" "4.11.0"

"@algolia/client-personalization@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-4.11.0.tgz#d3bf0e760f85df876b4baf5b81996f0aa3a59940"
integrity sha512-mI+X5IKiijHAzf9fy8VSl/GTT67dzFDnJ0QAM8D9cMPevnfX4U72HRln3Mjd0xEaYUOGve8TK/fMg7d3Z5yG6g==
dependencies:
"@algolia/client-common" "4.11.0"
"@algolia/requester-common" "4.11.0"
"@algolia/transporter" "4.11.0"

"@algolia/client-search@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-4.11.0.tgz#c1105d715a2a04ba27231eca86f5d6620f68f4ae"
integrity sha512-iovPLc5YgiXBdw2qMhU65sINgo9umWbHFzInxoNErWnYoTQWfXsW6P54/NlKx5uscoLVjSf+5RUWwFu5BX+lpw==
dependencies:
"@algolia/client-common" "4.11.0"
"@algolia/requester-common" "4.11.0"
"@algolia/transporter" "4.11.0"

"@algolia/logger-common@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/logger-common/-/logger-common-4.11.0.tgz#bac1c2d59d29dee378b57412c8edd435b97de663"
integrity sha512-pRMJFeOY8hoWKIxWuGHIrqnEKN/kqKh7UilDffG/+PeEGxBuku+Wq5CfdTFG0C9ewUvn8mAJn5BhYA5k8y0Jqg==

"@algolia/logger-console@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/logger-console/-/logger-console-4.11.0.tgz#ced19e3abb22eb782ed5268d51efb5aa9ef109ef"
integrity sha512-wXztMk0a3VbNmYP8Kpc+F7ekuvaqZmozM2eTLok0XIshpAeZ/NJDHDffXK2Pw+NF0wmHqurptLYwKoikjBYvhQ==
dependencies:
"@algolia/logger-common" "4.11.0"

"@algolia/requester-browser-xhr@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.11.0.tgz#f9e1ad56f185432aa8dde8cad53ae271fd5d6181"
integrity sha512-Fp3SfDihAAFR8bllg8P5ouWi3+qpEVN5e7hrtVIYldKBOuI/qFv80Zv/3/AMKNJQRYglS4zWyPuqrXm58nz6KA==
dependencies:
"@algolia/requester-common" "4.11.0"

"@algolia/requester-common@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/requester-common/-/requester-common-4.11.0.tgz#d16de98d3ff72434bac39e4d915eab08035946a9"
integrity sha512-+cZGe/9fuYgGuxjaBC+xTGBkK7OIYdfapxhfvEf03dviLMPmhmVYFJtJlzAjQ2YmGDJpHrGgAYj3i/fbs8yhiA==

"@algolia/requester-node-http@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-4.11.0.tgz#beb2b6b68d5f4ce15aec80ede623f0ac96991368"
integrity sha512-qJIk9SHRFkKDi6dMT9hba8X1J1z92T5AZIgl+tsApjTGIRQXJLTIm+0q4yOefokfu4CoxYwRZ9QAq+ouGwfeOg==
dependencies:
"@algolia/requester-common" "4.11.0"

"@algolia/transporter@4.11.0":
version "4.11.0"
resolved "https://registry.yarnpkg.com/@algolia/transporter/-/transporter-4.11.0.tgz#a8de3c173093ceceb02b26b577395ce3b3d4b96f"
integrity sha512-k4dyxiaEfYpw4UqybK9q7lrFzehygo6KV3OCYJMMdX0IMWV0m4DXdU27c1zYRYtthaFYaBzGF4Kjcl8p8vxCKw==
dependencies:
"@algolia/cache-common" "4.11.0"
"@algolia/logger-common" "4.11.0"
"@algolia/requester-common" "4.11.0"

"@babel/code-frame@*", "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.10.4", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.16.0", "@babel/code-frame@^7.8.3":
version "7.16.0"
resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.16.0.tgz#0dfc80309beec8411e65e706461c408b0bb9b431"
Expand Down Expand Up @@ -1437,6 +1560,21 @@
dependencies:
"@cspotcode/source-map-consumer" "0.8.0"

"@docsearch/css@3.0.0-alpha.41":
version "3.0.0-alpha.41"
resolved "https://registry.yarnpkg.com/@docsearch/css/-/css-3.0.0-alpha.41.tgz#c5c8e803541bd157ad86e764c2c1e9f1b5a68592"
integrity sha512-AP1jqcF/9jCrm4s0lcES3QAtHueyipKjd14L/pguk0CZYK7uI7hC0FWodmRmrgK3/HST9jiHa1waUMR6ZYedlQ==

"@docsearch/react@^3.0.0-alpha.39":
version "3.0.0-alpha.41"
resolved "https://registry.yarnpkg.com/@docsearch/react/-/react-3.0.0-alpha.41.tgz#07e85a664e85f251ce3d13153abce65a4d5997ab"
integrity sha512-UL0Gdter/NUea04lGuBGH0GzQ2/2q/hBfn7Rjo71rRKbjtfkQCM92leJ9tZ+9j9sFLoyuHb9XMm/B8vCjWwTEg==
dependencies:
"@algolia/autocomplete-core" "1.2.2"
"@algolia/autocomplete-preset-algolia" "1.2.2"
"@docsearch/css" "3.0.0-alpha.41"
algoliasearch "^4.0.0"

"@docusaurus/core@2.0.0-beta.9":
version "2.0.0-beta.9"
resolved "https://registry.yarnpkg.com/@docusaurus/core/-/core-2.0.0-beta.9.tgz#59b57c5e60fe83ef9e3c6aa7000d470eb0c52656"
Expand Down Expand Up @@ -1702,6 +1840,22 @@
tslib "^2.3.1"
utility-types "^3.10.0"

"@docusaurus/theme-search-algolia@^2.0.0-beta.9":
version "2.0.0-beta.9"
resolved "https://registry.yarnpkg.com/@docusaurus/theme-search-algolia/-/theme-search-algolia-2.0.0-beta.9.tgz#ccece22535b91e83757c21d895817c5f577fcc36"
integrity sha512-pbpA18kqr5H7A7snmHf4dzMYV+3nsTDYMhV9f2Tms7yP9cxW7ZMHJwaEKXh1myE58Nbkv84AF734TR1UgYrziw==
dependencies:
"@docsearch/react" "^3.0.0-alpha.39"
"@docusaurus/core" "2.0.0-beta.9"
"@docusaurus/theme-common" "2.0.0-beta.9"
"@docusaurus/utils" "2.0.0-beta.9"
"@docusaurus/utils-validation" "2.0.0-beta.9"
algoliasearch "^4.10.5"
algoliasearch-helper "^3.5.5"
clsx "^1.1.1"
eta "^1.12.3"
lodash "^4.17.20"

"@docusaurus/types@2.0.0-beta.9":
version "2.0.0-beta.9"
resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-2.0.0-beta.9.tgz#3561a0e3ce9bcb0892d02a025161bb854a189d10"
Expand Down Expand Up @@ -3956,6 +4110,33 @@ ajv@^8.0.1:
require-from-string "^2.0.2"
uri-js "^4.2.2"

algoliasearch-helper@^3.5.5:
version "3.6.2"
resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.6.2.tgz#45e19b12589cfa0c611b573287f65266ea2cc14a"
integrity sha512-Xx0NOA6k4ySn+R2l3UMSONAaMkyfmrZ3AP1geEMo32MxDJQJesZABZYsldO9fa6FKQxH91afhi4hO1G0Zc2opg==
dependencies:
events "^1.1.1"

algoliasearch@^4.0.0, algoliasearch@^4.10.5:
version "4.11.0"
resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-4.11.0.tgz#234befb3ac355c094077f0edf3777240b1ee013c"
integrity sha512-IXRj8kAP2WrMmj+eoPqPc6P7Ncq1yZkFiyDrjTBObV1ADNL8Z/KdZ+dWC5MmYcBLAbcB/mMCpak5N/D1UIZvsA==
dependencies:
"@algolia/cache-browser-local-storage" "4.11.0"
"@algolia/cache-common" "4.11.0"
"@algolia/cache-in-memory" "4.11.0"
"@algolia/client-account" "4.11.0"
"@algolia/client-analytics" "4.11.0"
"@algolia/client-common" "4.11.0"
"@algolia/client-personalization" "4.11.0"
"@algolia/client-search" "4.11.0"
"@algolia/logger-common" "4.11.0"
"@algolia/logger-console" "4.11.0"
"@algolia/requester-browser-xhr" "4.11.0"
"@algolia/requester-common" "4.11.0"
"@algolia/requester-node-http" "4.11.0"
"@algolia/transporter" "4.11.0"

all-contributors-cli@^6.20.0:
version "6.20.0"
resolved "https://registry.yarnpkg.com/all-contributors-cli/-/all-contributors-cli-6.20.0.tgz#9bc98dda38cb29cfe8afc8a78c004e14af25d2f6"
Expand Down Expand Up @@ -6602,6 +6783,11 @@ eventemitter3@^4.0.0, eventemitter3@^4.0.4:
resolved "https://registry.yarnpkg.com/eventemitter3/-/eventemitter3-4.0.7.tgz#2de9b68f6528d5644ef5c59526a1b4a07306169f"
integrity sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==

events@^1.1.1:
version "1.1.1"
resolved "https://registry.yarnpkg.com/events/-/events-1.1.1.tgz#9ebdb7635ad099c70dcc4c2a1f5004288e8bd924"
integrity sha1-nr23Y1rQmccNzEwqH1AEKI6L2SQ=

events@^3.2.0:
version "3.3.0"
resolved "https://registry.yarnpkg.com/events/-/events-3.3.0.tgz#31a95ad0a924e2d2c419a813aeb2c4e878ea7400"
Expand Down

0 comments on commit 46a9aee

Please sign in to comment.