Skip to content

Commit

Permalink
website: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Dec 24, 2024
1 parent 5ab16d1 commit 058c56a
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 0 deletions.
4 changes: 4 additions & 0 deletions website/docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ eliminating the need to add multiple folders to the `PATH`.
In summary, xpm packages can enhance and automate the installation
process for source libraries and tools.

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

</details>

## Features
Expand Down
23 changes: 23 additions & 0 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,10 @@ const config: Config = {
}
}
],

// No longer needed.
// themes: [ '@docusaurus/theme-search-algolia' ],

// https://docusaurus.io/docs/seo
themeConfig: {
// The project's social card, og:image, twitter:image, 1200x630
Expand Down Expand Up @@ -420,6 +424,25 @@ const config: Config = {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
algolia: {
// https://docsearch.algolia.com/docs/docsearch-v3/
appId: "KIDD7R4CL1",
apiKey: "ca2ffc431941284609f2d50202fc5506",
indexName: "xpackio",

// It ensures that search results are relevant to the current
// language and version. Enabled by default.
contextualSearch: false, // true,
// Optional: Replace parts of the item URLs from Algolia.
// Useful when using the same search index for multiple deployments
// using a different baseUrl. You can use regexp or string in the
// `from` param. For example: localhost:3000 vs myCompany.com/docs
// replaceSearchResultPathname: undefined,
// Optional: Algolia search parameters
searchParameters: {},
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: false, // 'search',
},
} satisfies Preset.ThemeConfig,

customFields: customFields,
Expand Down
2 changes: 2 additions & 0 deletions website/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
"@docusaurus/plugin-client-redirects": "3.6.3",
"@docusaurus/plugin-ideal-image": "3.6.3",
"@docusaurus/preset-classic": "3.6.3",
"@docusaurus/theme-search-algolia": "3.6.3",
"@mdx-js/react": "^3.1.0",
"clean-css": "~5.3.3",
"clsx": "^2.1.1",
"del-cli": "^6.0.0",
"prism-react-renderer": "^2.4.0",
Expand Down
16 changes: 16 additions & 0 deletions website/sidebar-user.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

export const userSidebarCategory = {
type: 'category',
label: 'User\'s Guide',
link: {
type: 'doc',
id: 'user/index',
},
items: [
{
type: 'doc',
id: 'user/index',
label: 'TODO'
}
]
}
2 changes: 2 additions & 0 deletions website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';





/**
* Creating a sidebar enables you to:
- create an ordered group of docs
Expand Down

0 comments on commit 058c56a

Please sign in to comment.