Skip to content

Commit 9c73b9e

Browse files
committed
website: updates
1 parent 8cd6228 commit 9c73b9e

File tree

6 files changed

+49
-0
lines changed

6 files changed

+49
-0
lines changed

website/docs/getting-started/index.mdx

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

114+
In summary, xpm packages can streamline and automate the installation
115+
process for source libraries and tools. Further details are available on the
116+
[xpm Concepts](https://xpack.github.io/xpm/docs/guide/concepts/) page.
117+
114118
</details>
115119

116120
## 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
@@ -383,6 +387,25 @@ const config: Config = {
383387
theme: prismThemes.github,
384388
darkTheme: prismThemes.dracula,
385389
},
390+
algolia: {
391+
// https://docsearch.algolia.com/docs/docsearch-v3/
392+
appId: "KIDD7R4CL1",
393+
apiKey: "ca2ffc431941284609f2d50202fc5506",
394+
indexName: "xpackio",
395+
396+
// It ensures that search results are relevant to the current
397+
// language and version. Enabled by default.
398+
contextualSearch: false, // true,
399+
// Optional: Replace parts of the item URLs from Algolia.
400+
// Useful when using the same search index for multiple deployments
401+
// using a different baseUrl. You can use regexp or string in the
402+
// `from` param. For example: localhost:3000 vs myCompany.com/docs
403+
// replaceSearchResultPathname: undefined,
404+
// Optional: Algolia search parameters
405+
searchParameters: {},
406+
// Optional: path for search page that enabled by default (`false` to disable it)
407+
searchPagePath: false, // 'search',
408+
},
386409
} satisfies Preset.ThemeConfig,
387410

388411
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",

website/sidebar-user.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
export const userSidebarCategory = {
3+
type: 'category',
4+
label: 'User\'s Guide',
5+
link: {
6+
type: 'doc',
7+
id: 'user/index',
8+
},
9+
items: [
10+
{
11+
type: 'doc',
12+
id: 'user/index',
13+
label: 'TODO'
14+
}
15+
]
16+
}

website/sidebars.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
77
import toolsSidebar from './sidebars-tools.js';
88

99

10+
11+
1012
/**
1113
* Creating a sidebar enables you to:
1214
- create an ordered group of docs

0 commit comments

Comments
 (0)