diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx index a87a86a..71853c4 100644 --- a/website/docs/maintainer/index.mdx +++ b/website/docs/maintainer/index.mdx @@ -396,6 +396,13 @@ caffeinate ssh xbbla32 +### Update the durations of the development builds + +In `website/docs/maintainer/_development-durations.mdx`, update +the durations of the builds. + +Commit with the message _**website: update development durations**_. + ### Update the trees in the Install Guide page Copy the trees displayed at the end of the test builds and paste to @@ -431,13 +438,6 @@ differences compared to the repository. Commit if necessary with the message _**package.json: update executables links**_. -### Update the durations of the development builds - -In `website/docs/maintainer/_development-durations.mdx`, update -the durations of the builds. - -Commit with the message _**website: update development durations**_. - ### How to build a debug version In some cases it is necessary to run a debug session with the binaries. diff --git a/website/docs/user/index.mdx b/website/docs/user/index.mdx index 9e28a74..cf640bb 100644 --- a/website/docs/user/index.mdx +++ b/website/docs/user/index.mdx @@ -33,12 +33,12 @@ import UseInTesting from './_use-in-testing.mdx'; This page is intended for those who plan to use the **xPack GNU bison** binaries in their workflows. + + - - diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 6d5d5e2..efece31 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -434,25 +434,46 @@ 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', - // }, + // https://docusaurus.io/docs/search#using-algolia-docsearch + // https://docsearch.algolia.com/docs/docsearch-v3/ + algolia: { + // The application ID provided by Algolia + appId: "KIDD7R4CL1", + + // Public API key: it is safe to commit it + apiKey: "ca2ffc431941284609f2d50202fc5506", + + indexName: "xpackio", + + // It ensures that search results are relevant to the current + // language and version. Enabled by default. + contextualSearch: true, + + // Optional: Specify domains where the navigation should occur + // through window.location instead on history.push. Useful when + // our Algolia config crawls multiple documentation sites and + // we want to navigate with window.location.href to them. + // externalUrlRegex: 'external\\.com|domain\\.com', + externalUrlRegex: 'xpack\\.github\\.io|xpack-dev-tools\\.github\\.io', + + // 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: { + // from: '/docs/', // or as RegExp: /\/docs\// + // to: '/', + // }, + + // Optional: Algolia search parameters + searchParameters: {}, + + // Optional: path for search page that enabled by default (`false` to disable it) + searchPagePath: 'search', + + // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default) + insights: false, + }, } satisfies Preset.ThemeConfig, customFields: customFields,