Skip to content

Commit fa1670e

Browse files
committed
docs(website): Add a local search plugin
Add `@easyops-cn/docusaurus-search-local` [1] as a local search plugin for Docusaurus. Fixes #1673. [1]: https://github.com/easyops-cn/docusaurus-search-local Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
1 parent b779920 commit fa1670e

File tree

3 files changed

+465
-26
lines changed

3 files changed

+465
-26
lines changed

website/docusaurus.config.ts

+16-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,22 @@ const config: Config = {
8484
],
8585
],
8686

87-
themes: ['@docusaurus/theme-mermaid', 'docusaurus-theme-openapi-docs'],
87+
themes: [
88+
'@docusaurus/theme-mermaid',
89+
'docusaurus-theme-openapi-docs',
90+
[
91+
'@easyops-cn/docusaurus-search-local',
92+
({
93+
hashed: true,
94+
indexBlog: false,
95+
docsDir: ['api', 'docs'],
96+
docsRouteBasePath: ['/api', '/docs'],
97+
searchResultLimits: 15,
98+
searchResultContextMaxLength: 200,
99+
explicitSearchResultPath: true
100+
})
101+
]
102+
],
88103

89104
themeConfig: {
90105
image: 'img/social-card.png',

website/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"@docusaurus/preset-classic": "3.7.0",
2424
"@docusaurus/theme-common": "3.7.0",
2525
"@docusaurus/theme-mermaid": "3.7.0",
26+
"@easyops-cn/docusaurus-search-local": "^0.48.0",
2627
"@iconify/react": "^5.0.2",
2728
"@mdx-js/react": "^3.0.0",
2829
"clsx": "^2.0.0",

0 commit comments

Comments
 (0)