Skip to content

Commit acbe7c9

Browse files
committed
website: updates
1 parent 9773d97 commit acbe7c9

File tree

4 files changed

+31
-0
lines changed

4 files changed

+31
-0
lines changed

website/docs/getting-started/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,10 @@ eliminating the need to add multiple folders to the `PATH`.
122122
In summary, xpm packages can enhance and automate the installation
123123
process for source libraries and tools.
124124

125+
In summary, xpm packages can streamline and automate the installation
126+
process for source libraries and tools. Further details are available on the
127+
[xpm Concepts](https://xpack.github.io/xpm/docs/guide/concepts/) page.
128+
125129
</details>
126130

127131
## Features

website/docusaurus.config.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,10 @@ const config: Config = {
232232
}
233233
}
234234
],
235+
236+
// No longer needed.
237+
// themes: [ '@docusaurus/theme-search-algolia' ],
238+
235239
// https://docusaurus.io/docs/seo
236240
themeConfig: {
237241
// The project's social card, og:image, twitter:image, 1200x630
@@ -420,6 +424,25 @@ const config: Config = {
420424
theme: prismThemes.github,
421425
darkTheme: prismThemes.dracula,
422426
},
427+
algolia: {
428+
// https://docsearch.algolia.com/docs/docsearch-v3/
429+
appId: "KIDD7R4CL1",
430+
apiKey: "ca2ffc431941284609f2d50202fc5506",
431+
indexName: "xpackio",
432+
433+
// It ensures that search results are relevant to the current
434+
// language and version. Enabled by default.
435+
contextualSearch: false, // true,
436+
// Optional: Replace parts of the item URLs from Algolia.
437+
// Useful when using the same search index for multiple deployments
438+
// using a different baseUrl. You can use regexp or string in the
439+
// `from` param. For example: localhost:3000 vs myCompany.com/docs
440+
// replaceSearchResultPathname: undefined,
441+
// Optional: Algolia search parameters
442+
searchParameters: {},
443+
// Optional: path for search page that enabled by default (`false` to disable it)
444+
searchPagePath: false, // 'search',
445+
},
423446
} satisfies Preset.ThemeConfig,
424447

425448
customFields: customFields,

website/package-lock.json

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

website/package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
"@docusaurus/plugin-client-redirects": "3.6.3",
2626
"@docusaurus/plugin-ideal-image": "3.6.3",
2727
"@docusaurus/preset-classic": "3.6.3",
28+
"@docusaurus/theme-search-algolia": "3.6.3",
2829
"@mdx-js/react": "^3.1.0",
30+
"clean-css": "~5.3.3",
2931
"clsx": "^2.1.1",
3032
"del-cli": "^6.0.0",
3133
"prism-react-renderer": "^2.4.0",

0 commit comments

Comments
 (0)