diff --git a/README.md b/README.md index c17b714..6388f07 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # The xPack Build Box -The environment used to build the xPack Binary Development Tools. +The environment used to build the xPack Binary Development Tools ## Project documentation @@ -13,11 +13,9 @@ please refer to the ## Project source - The source code is available on [GitHub](https://github.com/xpack-dev-tools/xpack-build-box/). - ## License Unless otherwise stated, the original content is released under the terms of the diff --git a/website/docs/developer/_common/_get-project-sources.mdx b/website/docs/developer/_common/_get-project-sources.mdx deleted file mode 100644 index bdd071b..0000000 --- a/website/docs/developer/_common/_get-project-sources.mdx +++ /dev/null @@ -1,39 +0,0 @@ -{/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} - -{/* ------------------------------------------------------------------------ */} - -## Get project sources - -The project is hosted on GitHub: - -- https://github.com/xpack-dev-tools/xpack-build-box.git - -The project uses multiple branches: - -- `master`, with the latest stable version (default) -- `development`, with the current development version -- `website`, with the current content of the website; pushes to this branch automatically trigger publishes the main website - -To clone the stable branch (`master`), run the following commands in a -terminal (on Windows use the Git Bash console): - -```sh -mkdir ~/Work/npm-packages && cd ~/Work/npm-packages -git clone https://github.com/xpack-dev-tools/xpack-build-box.git xpack-build-box.git -``` - -For **development** purposes, clone the `development` branch: - -```sh -mkdir ~/Work/npm-packages && cd ~/Work/npm-packages -git clone \ - --branch development \ - https://github.com/xpack-dev-tools/xpack-build-box.git xpack-build-box.git -``` - -Or, if the repo was already cloned: - -```sh -git -C ~/Work/npm-packages/xpack-build-box.git pull -``` diff --git a/website/docs/developer/_common/_prerequisites.mdx b/website/docs/developer/_common/_prerequisites.mdx deleted file mode 100644 index 6e1743d..0000000 --- a/website/docs/developer/_common/_prerequisites.mdx +++ /dev/null @@ -1,26 +0,0 @@ -{/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} - -import CodeBlock from '@theme/CodeBlock'; - -{/* ------------------------------------------------------------------------ */} - -## Prerequisites - -**** is a portable Node.js module; -development can be -performed on macOS, GNU/Linux and even Windows (although some npm scripts -must be executed in a Git Bash terminal). - -The prerequisites are: - -- git -- node >= {props.nodeVersion || 'N.N.N'} -- npm - -To ensure compatibility with older node, preferably revert to an older one: - - { -`nvm use --lts ${props.nodeVersionMajor || 'NN'} -code -`} diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx index ce1b2a2..164ce67 100644 --- a/website/docs/getting-started/index.mdx +++ b/website/docs/getting-started/index.mdx @@ -17,14 +17,15 @@ date: 2024-10-24 18:58:00 +0300 import Link from '@docusaurus/Link'; -import UserDeveloperMaintainer from './_common/_user-developer-maintainer.mdx'; +import MoreCredits from './_more-credits.mdx' +import UserDeveloperMaintainer from './_common/_user-developer-maintainer.mdx'; + import Overview from './_overview.mdx' import Compatibility from './_compatibility.mdx' import Status from './_status.mdx' -import MoreCredits from './_more-credits.mdx' {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx index 7acbb91..7b0a176 100644 --- a/website/docs/maintainer/index.mdx +++ b/website/docs/maintainer/index.mdx @@ -23,7 +23,7 @@ import CustomMaintainer from './_custom-maintainer.mdx' {/* ------------------------------------------------------------------------ */} -# How to make new xPack Build Box releases +# Maintainer's Guide diff --git a/website/docs/metadata/_common/_minimum-required.mdx b/website/docs/metadata/_common/_minimum-required.mdx deleted file mode 100644 index cb3cadb..0000000 --- a/website/docs/metadata/_common/_minimum-required.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} - -{/* ------------------------------------------------------------------------ */} - -This definition is a mechanism to identify the minimum required -**{props.name}** version necessary for correctly interpreting the current definitions in {props.fileName}.json, thereby ensuring compatibility with future (potentially incompatible) **{props.name}** versions. - -The minimum{String(props.name).charAt(0).toUpperCase() + String(props.name).slice(1)}Required property has two primary purposes: - -- it prevents the use of an outdated **{props.name}** with a newer {props.fileName}.json -- it allows a newer **{props.name}** to revert some functionality to match the -older minimum required **{props.name}**. - -The mechanism is similar to that used by CMake; the policies are -documented on the separate [Policies](/docs/user/policies/) pages. diff --git a/website/docs/test/index.mdx b/website/docs/test/index.mdx index 0c20118..bcd2382 100644 --- a/website/docs/test/index.mdx +++ b/website/docs/test/index.mdx @@ -16,11 +16,10 @@ something: "Some text" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; import CodeBlock from '@theme/CodeBlock'; -import Heading from '@theme/Heading'; - export const world = 'World' export const version = '11.2.1' export const xpackSubversion = '1.2' @@ -184,7 +183,27 @@ const visit = require('unist-util-visit'); +## Headers in tabs + To display headings not showing in the TOC: My Heading +## Conditional markdown + +``` +### Edit the {props.doReconstruct === "true" ? (`LICENSE-XPACK`) : (`LICENSE`)} file +``` + +or + +``` + +``` diff --git a/website/docs/user/policies/_common/_policies.mdx b/website/docs/user/policies/_common/_policies.mdx deleted file mode 100644 index 564cece..0000000 --- a/website/docs/user/policies/_common/_policies.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} - -{/* ------------------------------------------------------------------------ */} - -Similarly to CMake, **{props.name}**, policies are employed to preserve backward-compatible behaviour across multiple releases. - -Newer **{props.name}** releases can adjust some functionality to match that of an older release, based on the value of the minimum{String(props.name).charAt(0).toUpperCase() + String(props.name).slice(1)}Required property in {props.fileName}.json. - -When such policies are applied, warnings are issued to inform developers about deprecated features, providing them with time to update their packages. - -The following policies are available (in reverse chronological order): diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 54423e5..12123a3 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -75,9 +75,12 @@ const config: Config = { organizationName: 'xpack-dev-tools', // Usually your GitHub org/user name. projectName: 'xpack-build-box', // Usually your repo name. + onBrokenAnchors: 'throw', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'throw', + onDuplicateRoutes: 'throw', + // Useful for the sitemap.xml, to avoid redirects, since // GitHub redirects all to trailing slash. trailingSlash: true, diff --git a/website/package.json b/website/package.json index 52abc87..23b92fe 100644 --- a/website/package.json +++ b/website/package.json @@ -20,7 +20,9 @@ "npm-link-helper": "npm link @xpack/docusaurus-template-liquid @xpack/npm-packages-helper", "generate-website-commons": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-commons.sh", "import-website-releases": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/website-import-releases.sh", - "generate-website-blog-post": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-blog-post.sh" + "generate-website-blog-post": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-blog-post.sh", + "deep-clean": "del-cli .docusaurus build node_modules package-lock.json", + "generate-dependencies-details": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-dependencies-details.sh" }, "dependencies": { "@docusaurus/core": "3.6.3", @@ -31,7 +33,8 @@ "clsx": "^2.1.1", "prism-react-renderer": "^2.4.0", "react": "^18.0.0", - "react-dom": "^18.0.0" + "react-dom": "^18.0.0", + "del-cli": "^6.0.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "3.6.3", diff --git a/website/sidebars.ts b/website/sidebars.ts index 8aa3b3c..fc46ed3 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -23,7 +23,6 @@ const sidebars: SidebarsConfig = { id: 'getting-started/index', label: 'Getting Started' }, - userSidebarCategory, { type: 'doc', diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 00852ad..ebde8f6 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -56,6 +56,10 @@ hr.hero__hr2 { height: 2px; } +hr.hero__hr2_margin { + margin: calc(var(--ifm-hr-margin-vertical) / 2); +} + /* Reduce size of blog titles (H2 is 2rem) */ .title_f1Hy { font-size: 2.5rem; /* 3rem; */