Skip to content

Commit ee74bf4

Browse files
ibgreenibgreen
authored
fix(docs) Restore local search in website (#314)
1 parent a8c451e commit ee74bf4

File tree

3 files changed

+214
-18
lines changed

3 files changed

+214
-18
lines changed

‎website/docusaurus.config.js‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,19 @@ const config = {
4646
]
4747
],
4848

49+
themes: [
50+
[
51+
'@cmfcmf/docusaurus-search-local',
52+
/** @type {import('@cmfcmf/docusaurus-search-local').PluginOptions} */
53+
({
54+
indexDocs: true,
55+
indexBlog: false,
56+
indexPages: true,
57+
// highlightSearchTermsOnTargetPage: true
58+
})
59+
]
60+
],
61+
4962
plugins: [
5063
[
5164
'./ocular-docusaurus-plugin',
@@ -220,17 +233,6 @@ const config = {
220233
],
221234
copyright: `Copyright © ${new Date().getFullYear()} OpenJS Foundation`
222235
},
223-
algolia: {
224-
// The application ID provided by Algolia
225-
appId: '8EVYAVB4KT',
226-
// Public API key: it is safe to commit it
227-
apiKey: 'a3fe1388353d733272ffdf148c53eeaa',
228-
indexName: 'deck',
229-
// Optional: see doc section below
230-
contextualSearch: true,
231-
// Optional: path for search page that enabled by default (`false` to disable it)
232-
searchPagePath: false
233-
},
234236
prism: {
235237
theme: lightCodeTheme,
236238
darkTheme: darkCodeTheme

‎website/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
"styled-react-modal": "^3.1.1"
4646
},
4747
"devDependencies": {
48+
"@cmfcmf/docusaurus-search-local": "^2",
4849
"@docusaurus/core": "^3.9.2",
4950
"@docusaurus/module-type-aliases": "^3.9.2",
5051
"@docusaurus/plugin-content-docs": "^3.9.2",

‎website/yarn.lock‎

Lines changed: 200 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,32 @@ __metadata:
8080
languageName: node
8181
linkType: hard
8282

83+
"@algolia/autocomplete-core@npm:1.19.4":
84+
version: 1.19.4
85+
resolution: "@algolia/autocomplete-core@npm:1.19.4"
86+
dependencies:
87+
"@algolia/autocomplete-plugin-algolia-insights": "npm:1.19.4"
88+
"@algolia/autocomplete-shared": "npm:1.19.4"
89+
checksum: 10c0/60c7da4f284f9376ff70c65cee98ed576f08eb634d70a2035c83b89bb1d1a6c72d05247ce40c7c3b6da95cf6a0d5beb8856dc51d15a759be1bb5d8087a51817b
90+
languageName: node
91+
linkType: hard
92+
93+
"@algolia/autocomplete-js@npm:^1.8.2":
94+
version: 1.19.4
95+
resolution: "@algolia/autocomplete-js@npm:1.19.4"
96+
dependencies:
97+
"@algolia/autocomplete-core": "npm:1.19.4"
98+
"@algolia/autocomplete-preset-algolia": "npm:1.19.4"
99+
"@algolia/autocomplete-shared": "npm:1.19.4"
100+
htm: "npm:^3.1.1"
101+
preact: "npm:^10.13.2"
102+
peerDependencies:
103+
"@algolia/client-search": ">= 4.5.1 < 6"
104+
algoliasearch: ">= 4.9.1 < 6"
105+
checksum: 10c0/db41142ffd9727982c61f46fcf03c1332b1158b702a4108ee5ef9cf0af12bfb4e892095601c2bb70d369f0ff59490fab88fb9bbe692a3a8d03763ac164ecd65b
106+
languageName: node
107+
linkType: hard
108+
83109
"@algolia/autocomplete-plugin-algolia-insights@npm:1.19.2":
84110
version: 1.19.2
85111
resolution: "@algolia/autocomplete-plugin-algolia-insights@npm:1.19.2"
@@ -91,6 +117,29 @@ __metadata:
91117
languageName: node
92118
linkType: hard
93119

120+
"@algolia/autocomplete-plugin-algolia-insights@npm:1.19.4":
121+
version: 1.19.4
122+
resolution: "@algolia/autocomplete-plugin-algolia-insights@npm:1.19.4"
123+
dependencies:
124+
"@algolia/autocomplete-shared": "npm:1.19.4"
125+
peerDependencies:
126+
search-insights: ">= 1 < 3"
127+
checksum: 10c0/881c4a17db6098b78a70112e0caa9d7ad4921880cea75ef7cc4dd5af04fff648c5273c9a53f2e4ffddfd0c0be19045ea030a4325beb6beb7449d177cae9c6508
128+
languageName: node
129+
linkType: hard
130+
131+
"@algolia/autocomplete-preset-algolia@npm:1.19.4":
132+
version: 1.19.4
133+
resolution: "@algolia/autocomplete-preset-algolia@npm:1.19.4"
134+
dependencies:
135+
"@algolia/autocomplete-shared": "npm:1.19.4"
136+
peerDependencies:
137+
"@algolia/client-search": ">= 4.9.1 < 6"
138+
algoliasearch: ">= 4.9.1 < 6"
139+
checksum: 10c0/03d6d0572e4db7b61cd2cb6cf921745eb8b0c82eb7fd08b18827df420f5e33fac11ffa651c7485d6e0ed2313b4aacbe9215788ae5a29ae5f1f1dd291570ccccd
140+
languageName: node
141+
linkType: hard
142+
94143
"@algolia/autocomplete-shared@npm:1.19.2":
95144
version: 1.19.2
96145
resolution: "@algolia/autocomplete-shared@npm:1.19.2"
@@ -101,6 +150,23 @@ __metadata:
101150
languageName: node
102151
linkType: hard
103152

153+
"@algolia/autocomplete-shared@npm:1.19.4":
154+
version: 1.19.4
155+
resolution: "@algolia/autocomplete-shared@npm:1.19.4"
156+
peerDependencies:
157+
"@algolia/client-search": ">= 4.9.1 < 6"
158+
algoliasearch: ">= 4.9.1 < 6"
159+
checksum: 10c0/e5e40218333132ee9778d08d059e21acaedf3dd94f10d4b89f88825f3b8ecfba6f492a21528655c948943890778c2f230fbd4ab2e6160fbc34e6c56bf61f5714
160+
languageName: node
161+
linkType: hard
162+
163+
"@algolia/autocomplete-theme-classic@npm:^1.8.2":
164+
version: 1.19.4
165+
resolution: "@algolia/autocomplete-theme-classic@npm:1.19.4"
166+
checksum: 10c0/3a7455cb851ae0d020f36560caf705295e7272fe05d211d69f279947cc56fa0836774b109dcfb828e93a9478e744bf51795d3082f32028118db6389cef614c96
167+
languageName: node
168+
linkType: hard
169+
104170
"@algolia/cache-browser-local-storage@npm:4.25.2":
105171
version: 4.25.2
106172
resolution: "@algolia/cache-browser-local-storage@npm:4.25.2"
@@ -237,7 +303,7 @@ __metadata:
237303
languageName: node
238304
linkType: hard
239305

240-
"@algolia/client-search@npm:4.25.2":
306+
"@algolia/client-search@npm:4.25.2, @algolia/client-search@npm:^4.12.0":
241307
version: 4.25.2
242308
resolution: "@algolia/client-search@npm:4.25.2"
243309
dependencies:
@@ -1680,6 +1746,31 @@ __metadata:
16801746
languageName: node
16811747
linkType: hard
16821748

1749+
"@cmfcmf/docusaurus-search-local@npm:^2":
1750+
version: 2.0.1
1751+
resolution: "@cmfcmf/docusaurus-search-local@npm:2.0.1"
1752+
dependencies:
1753+
"@algolia/autocomplete-js": "npm:^1.8.2"
1754+
"@algolia/autocomplete-theme-classic": "npm:^1.8.2"
1755+
"@algolia/client-search": "npm:^4.12.0"
1756+
algoliasearch: "npm:^4.12.0"
1757+
cheerio: "npm:^1.0.0"
1758+
clsx: "npm:^2.0.0"
1759+
lunr-languages: "npm:^1.4.0"
1760+
mark.js: "npm:^8.11.1"
1761+
tslib: "npm:^2.6.3"
1762+
peerDependencies:
1763+
"@docusaurus/core": ^3.0.0
1764+
nodejieba: ^2.5.0 || ^3.0.0
1765+
react: ^18 || ^19
1766+
react-dom: ^18 || ^19
1767+
peerDependenciesMeta:
1768+
nodejieba:
1769+
optional: true
1770+
checksum: 10c0/c0986aeb26c8c50b1d9fcc88c379fd92ba4adc5627d66df09c404428b58963731e8568a3f539c78257902da1b98c1be401dc2a1432cb7477cc99226da2fc23cb
1771+
languageName: node
1772+
linkType: hard
1773+
16831774
"@colors/colors@npm:1.5.0":
16841775
version: 1.5.0
16851776
resolution: "@colors/colors@npm:1.5.0"
@@ -6392,7 +6483,7 @@ __metadata:
63926483
languageName: node
63936484
linkType: hard
63946485

6395-
"algoliasearch@npm:^4.24.0":
6486+
"algoliasearch@npm:^4.12.0, algoliasearch@npm:^4.24.0":
63966487
version: 4.25.2
63976488
resolution: "algoliasearch@npm:4.25.2"
63986489
dependencies:
@@ -7155,6 +7246,25 @@ __metadata:
71557246
languageName: node
71567247
linkType: hard
71577248

7249+
"cheerio@npm:^1.0.0":
7250+
version: 1.1.2
7251+
resolution: "cheerio@npm:1.1.2"
7252+
dependencies:
7253+
cheerio-select: "npm:^2.1.0"
7254+
dom-serializer: "npm:^2.0.0"
7255+
domhandler: "npm:^5.0.3"
7256+
domutils: "npm:^3.2.2"
7257+
encoding-sniffer: "npm:^0.2.1"
7258+
htmlparser2: "npm:^10.0.0"
7259+
parse5: "npm:^7.3.0"
7260+
parse5-htmlparser2-tree-adapter: "npm:^7.1.0"
7261+
parse5-parser-stream: "npm:^7.1.2"
7262+
undici: "npm:^7.12.0"
7263+
whatwg-mimetype: "npm:^4.0.0"
7264+
checksum: 10c0/2c6d2274666fe122f54fdca457ee76453e1a993b19563acaa23eb565bf7776f0f01e4c3800092f00e84aa13c83a161f0cf000ac0a8332d1d7f2b2387d6ecc5fc
7265+
languageName: node
7266+
linkType: hard
7267+
71587268
"chokidar@npm:^3.5.3, chokidar@npm:^3.6.0":
71597269
version: 3.6.0
71607270
resolution: "chokidar@npm:3.6.0"
@@ -8297,7 +8407,7 @@ __metadata:
82978407
languageName: node
82988408
linkType: hard
82998409

8300-
"domutils@npm:^3.0.1":
8410+
"domutils@npm:^3.0.1, domutils@npm:^3.2.1, domutils@npm:^3.2.2":
83018411
version: 3.2.2
83028412
resolution: "domutils@npm:3.2.2"
83038413
dependencies:
@@ -8436,6 +8546,16 @@ __metadata:
84368546
languageName: node
84378547
linkType: hard
84388548

8549+
"encoding-sniffer@npm:^0.2.1":
8550+
version: 0.2.1
8551+
resolution: "encoding-sniffer@npm:0.2.1"
8552+
dependencies:
8553+
iconv-lite: "npm:^0.6.3"
8554+
whatwg-encoding: "npm:^3.1.1"
8555+
checksum: 10c0/d6b591880788f3baf8dd1744636dd189d24a1ec93e6f9817267c60ac3458a5191ca70ab1a186fb67731beff1c3489c6527dfdc4718158ed8460ab2f400dd5e7d
8556+
languageName: node
8557+
linkType: hard
8558+
84398559
"encoding@npm:^0.1.13":
84408560
version: 0.1.13
84418561
resolution: "encoding@npm:0.1.13"
@@ -9644,6 +9764,13 @@ __metadata:
96449764
languageName: node
96459765
linkType: hard
96469766

9767+
"htm@npm:^3.1.1":
9768+
version: 3.1.1
9769+
resolution: "htm@npm:3.1.1"
9770+
checksum: 10c0/0de4c8fff2b8e76c162235ae80dbf93ca5eef1575bd50596a06ce9bebf1a6da5efc467417c53034a9ffa2ab9ecff819cbec041dc9087894b2b900ad4de26c7e7
9771+
languageName: node
9772+
linkType: hard
9773+
96479774
"html-escaper@npm:^2.0.2":
96489775
version: 2.0.2
96499776
resolution: "html-escaper@npm:2.0.2"
@@ -9720,6 +9847,18 @@ __metadata:
97209847
languageName: node
97219848
linkType: hard
97229849

9850+
"htmlparser2@npm:^10.0.0":
9851+
version: 10.0.0
9852+
resolution: "htmlparser2@npm:10.0.0"
9853+
dependencies:
9854+
domelementtype: "npm:^2.3.0"
9855+
domhandler: "npm:^5.0.3"
9856+
domutils: "npm:^3.2.1"
9857+
entities: "npm:^6.0.0"
9858+
checksum: 10c0/47cfa37e529c86a7ba9a1e0e6f951ad26ef8ca5af898ab6e8916fa02c0264c1453b4a65f28b7b8a7f9d0d29b5a70abead8203bf8b3f07bc69407e85e7d9a68e4
9859+
languageName: node
9860+
linkType: hard
9861+
97239862
"htmlparser2@npm:^6.1.0":
97249863
version: 6.1.0
97259864
resolution: "htmlparser2@npm:6.1.0"
@@ -9872,7 +10011,7 @@ __metadata:
987210011
languageName: node
987310012
linkType: hard
987410013

9875-
"iconv-lite@npm:^0.6.2":
10014+
"iconv-lite@npm:0.6.3, iconv-lite@npm:^0.6.2, iconv-lite@npm:^0.6.3":
987610015
version: 0.6.3
987710016
resolution: "iconv-lite@npm:0.6.3"
987810017
dependencies:
@@ -10803,6 +10942,13 @@ __metadata:
1080310942
languageName: node
1080410943
linkType: hard
1080510944

10945+
"lunr-languages@npm:^1.4.0":
10946+
version: 1.14.0
10947+
resolution: "lunr-languages@npm:1.14.0"
10948+
checksum: 10c0/5dc26fa75c8f3f14a69b3d54ae1228907b3552bc26727a14c5f302aab05d2547a924d095f075c9d3439756a38e2dafb78d1b74fc862dc290a13ddce236a55e87
10949+
languageName: node
10950+
linkType: hard
10951+
1080610952
"lz4js@npm:^0.2.0":
1080710953
version: 0.2.0
1080810954
resolution: "lz4js@npm:0.2.0"
@@ -10912,6 +11058,13 @@ __metadata:
1091211058
languageName: node
1091311059
linkType: hard
1091411060

11061+
"mark.js@npm:^8.11.1":
11062+
version: 8.11.1
11063+
resolution: "mark.js@npm:8.11.1"
11064+
checksum: 10c0/5e69e776db61abdd857b5cbb7070c8a3b1b0e5c12bf077fcd5a8c6f17b1f85ed65275aba5662b57136d1b9f82b54bb34d4ef4220f7703c9a7ab806ae1e208cff
11065+
languageName: node
11066+
linkType: hard
11067+
1091511068
"markdown-extensions@npm:^2.0.0":
1091611069
version: 2.0.0
1091711070
resolution: "markdown-extensions@npm:2.0.0"
@@ -12487,7 +12640,7 @@ __metadata:
1248712640
languageName: node
1248812641
linkType: hard
1248912642

12490-
"parse5-htmlparser2-tree-adapter@npm:^7.0.0":
12643+
"parse5-htmlparser2-tree-adapter@npm:^7.0.0, parse5-htmlparser2-tree-adapter@npm:^7.1.0":
1249112644
version: 7.1.0
1249212645
resolution: "parse5-htmlparser2-tree-adapter@npm:7.1.0"
1249312646
dependencies:
@@ -12497,7 +12650,16 @@ __metadata:
1249712650
languageName: node
1249812651
linkType: hard
1249912652

12500-
"parse5@npm:^7.0.0":
12653+
"parse5-parser-stream@npm:^7.1.2":
12654+
version: 7.1.2
12655+
resolution: "parse5-parser-stream@npm:7.1.2"
12656+
dependencies:
12657+
parse5: "npm:^7.0.0"
12658+
checksum: 10c0/e236c61000d38ecad369e725a48506b051cebad8abb00e6d4e8bff7aa85c183820fcb45db1559cc90955bdbbdbd665ea94c41259594e74566fff411478dc7fcb
12659+
languageName: node
12660+
linkType: hard
12661+
12662+
"parse5@npm:^7.0.0, parse5@npm:^7.3.0":
1250112663
version: 7.3.0
1250212664
resolution: "parse5@npm:7.3.0"
1250312665
dependencies:
@@ -13496,6 +13658,13 @@ __metadata:
1349613658
languageName: node
1349713659
linkType: hard
1349813660

13661+
"preact@npm:^10.13.2":
13662+
version: 10.27.2
13663+
resolution: "preact@npm:10.27.2"
13664+
checksum: 10c0/951b708f7afa34391e054b0f1026430e8f5f6d5de24020beef70288e17067e473b9ee5503a994e0a80ced014826f56708fea5902f80346432c22dfcf3dff4be7
13665+
languageName: node
13666+
linkType: hard
13667+
1349913668
"pretty-error@npm:^4.0.0":
1350013669
version: 4.0.0
1350113670
resolution: "pretty-error@npm:4.0.0"
@@ -13550,6 +13719,7 @@ __metadata:
1355013719
version: 0.0.0-use.local
1355113720
resolution: "project-website@workspace:."
1355213721
dependencies:
13722+
"@cmfcmf/docusaurus-search-local": "npm:^2"
1355313723
"@deck.gl/core": "npm:~9.2.1"
1355413724
"@deck.gl/google-maps": "npm:~9.2.1"
1355513725
"@deck.gl/json": "npm:~9.2.1"
@@ -15604,7 +15774,7 @@ __metadata:
1560415774
languageName: node
1560515775
linkType: hard
1560615776

15607-
"tslib@npm:^2.0.0, tslib@npm:^2.0.3, tslib@npm:^2.6.0, tslib@npm:^2.8.1":
15777+
"tslib@npm:^2.0.0, tslib@npm:^2.0.3, tslib@npm:^2.6.0, tslib@npm:^2.6.3, tslib@npm:^2.8.1":
1560815778
version: 2.8.1
1560915779
resolution: "tslib@npm:2.8.1"
1561015780
checksum: 10c0/9c4759110a19c53f992d9aae23aac5ced636e99887b51b9e61def52611732872ff7668757d4e4c61f19691e36f4da981cd9485e869b4a7408d689f6bf1f14e62
@@ -15708,6 +15878,13 @@ __metadata:
1570815878
languageName: node
1570915879
linkType: hard
1571015880

15881+
"undici@npm:^7.12.0":
15882+
version: 7.16.0
15883+
resolution: "undici@npm:7.16.0"
15884+
checksum: 10c0/efd867792e9f233facf9efa0a087e2d9c3e4415c0b234061b9b40307ca4fa01d945fee4d43c7b564e1b80e0d519bcc682f9f6e0de13c717146c00a80e2f1fb0f
15885+
languageName: node
15886+
linkType: hard
15887+
1571115888
"unicode-canonical-property-names-ecmascript@npm:^2.0.0":
1571215889
version: 2.0.1
1571315890
resolution: "unicode-canonical-property-names-ecmascript@npm:2.0.1"
@@ -16263,6 +16440,22 @@ __metadata:
1626316440
languageName: node
1626416441
linkType: hard
1626516442

16443+
"whatwg-encoding@npm:^3.1.1":
16444+
version: 3.1.1
16445+
resolution: "whatwg-encoding@npm:3.1.1"
16446+
dependencies:
16447+
iconv-lite: "npm:0.6.3"
16448+
checksum: 10c0/273b5f441c2f7fda3368a496c3009edbaa5e43b71b09728f90425e7f487e5cef9eb2b846a31bd760dd8077739c26faf6b5ca43a5f24033172b003b72cf61a93e
16449+
languageName: node
16450+
linkType: hard
16451+
16452+
"whatwg-mimetype@npm:^4.0.0":
16453+
version: 4.0.0
16454+
resolution: "whatwg-mimetype@npm:4.0.0"
16455+
checksum: 10c0/a773cdc8126b514d790bdae7052e8bf242970cebd84af62fb2f35a33411e78e981f6c0ab9ed1fe6ec5071b09d5340ac9178e05b52d35a9c4bcf558ba1b1551df
16456+
languageName: node
16457+
linkType: hard
16458+
1626616459
"which@npm:^2.0.1":
1626716460
version: 2.0.2
1626816461
resolution: "which@npm:2.0.2"

0 commit comments

Comments
 (0)