diff --git a/website/README.md b/website/README.md index e30a927..292700f 100644 --- a/website/README.md +++ b/website/README.md @@ -5,6 +5,27 @@ a modern static website generator. The folder was created with: -```bash +```sh npx create-docusaurus website classic --typescript ``` + +## docusaurus-plugin-typedoc + +This plugin uses [TypeDoc](https://typedoc.org) to generate +the reference as markdown pages in `docs/api`. + +- https://typedoc-plugin-markdown.org/plugins/docusaurus + +```sh +cd website +npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev +``` + +[!NOTE] +There is a new spec ([TSDoc](https://tsdoc.org)), pushed by +Microsoft, slightly different, for example there are no +categories or groups. + +[!NOTE] +There is also another plugin, `docusaurus-plugin-typedoc-api`, but +it is no longer maintained. diff --git a/website/babel.config.js b/website/babel.config.js index 5ffc3f2..535203f 100644 --- a/website/babel.config.js +++ b/website/babel.config.js @@ -1,5 +1,5 @@ // DO NOT EDIT! -// Automatically generated from xbb-helper/templates/docusaurus/common. +// Automatically generated from docusaurus-template-liquid/templates/docusaurus. module.exports = { presets: [require.resolve('@docusaurus/core/lib/babel/preset')], diff --git a/website/blog/_common/_deprecation-notices-glib-2.27.mdx b/website/blog/_common/_deprecation-notices-glib-2.27.mdx index e1727b3..ce3512f 100644 --- a/website/blog/_common/_deprecation-notices-glib-2.27.mdx +++ b/website/blog/_common/_deprecation-notices-glib-2.27.mdx @@ -1,6 +1,6 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/blog/_common/_download-analytics.mdx b/website/blog/_common/_download-analytics.mdx index 39fd6ea..33f805c 100644 --- a/website/blog/_common/_download-analytics.mdx +++ b/website/blog/_common/_download-analytics.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import Image from '@theme/IdealImage'; diff --git a/website/blog/_common/_prerequisites-glib-2.27.mdx b/website/blog/_common/_prerequisites-glib-2.27.mdx index 6140b55..bd57b18 100644 --- a/website/blog/_common/_prerequisites-glib-2.27.mdx +++ b/website/blog/_common/_prerequisites-glib-2.27.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/blog/authors.yml b/website/blog/authors.yml new file mode 100644 index 0000000..dae7df3 --- /dev/null +++ b/website/blog/authors.yml @@ -0,0 +1,14 @@ +# DO NOT EDIT! +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. + +ilg-ul: + name: Liviu Ionescu (ilg) + email: ilg@livius.net + url: https://github.com/ilg-ul + image_url: https://github.com/ilg-ul.png + page: true + socials: + x: ilegeul + github: ilg-ul + linkedin: https://www.linkedin.com/in/liviu-ionescu/ + wordpress: https://ilgthegeek.wordpress.com diff --git a/website/blog/tags.yml b/website/blog/tags.yml new file mode 100644 index 0000000..34dd52c --- /dev/null +++ b/website/blog/tags.yml @@ -0,0 +1,6 @@ +# DO NOT EDIT! +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. + +releases: + +web: diff --git a/website/docs/about/_common/History32bitDiscontinued/index.tsx b/website/docs/about/_common/History32bitDiscontinued/index.tsx index 550c39e..177d0b8 100644 --- a/website/docs/about/_common/History32bitDiscontinued/index.tsx +++ b/website/docs/about/_common/History32bitDiscontinued/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/docs/about/_common/HistoryAppleSiliconAdded/index.tsx b/website/docs/about/_common/HistoryAppleSiliconAdded/index.tsx index 42a027d..7688c1f 100644 --- a/website/docs/about/_common/HistoryAppleSiliconAdded/index.tsx +++ b/website/docs/about/_common/HistoryAppleSiliconAdded/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/docs/about/_common/HistoryArmLinuxAdded/index.tsx b/website/docs/about/_common/HistoryArmLinuxAdded/index.tsx index 7702422..7319a88 100644 --- a/website/docs/about/_common/HistoryArmLinuxAdded/index.tsx +++ b/website/docs/about/_common/HistoryArmLinuxAdded/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/docs/about/_common/HistoryPlatformsAdded/index.tsx b/website/docs/about/_common/HistoryPlatformsAdded/index.tsx index 80fd948..95df6f6 100644 --- a/website/docs/about/_common/HistoryPlatformsAdded/index.tsx +++ b/website/docs/about/_common/HistoryPlatformsAdded/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/docs/about/_common/HistoryRenameXpack/index.tsx b/website/docs/about/_common/HistoryRenameXpack/index.tsx index db25b07..42a6168 100644 --- a/website/docs/about/_common/HistoryRenameXpack/index.tsx +++ b/website/docs/about/_common/HistoryRenameXpack/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/docs/about/_common/HistoryWindowsUcrt/index.tsx b/website/docs/about/_common/HistoryWindowsUcrt/index.tsx index af51abc..b1fbe3a 100644 --- a/website/docs/about/_common/HistoryWindowsUcrt/index.tsx +++ b/website/docs/about/_common/HistoryWindowsUcrt/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/docs/about/_common/HistoryXpm/index.tsx b/website/docs/about/_common/HistoryXpm/index.tsx index e9d94a2..fb0f7bf 100644 --- a/website/docs/about/_common/HistoryXpm/index.tsx +++ b/website/docs/about/_common/HistoryXpm/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/docs/about/_common/HistoryZipAdded/index.tsx b/website/docs/about/_common/HistoryZipAdded/index.tsx index 86d9375..f1a6fe1 100644 --- a/website/docs/about/_common/HistoryZipAdded/index.tsx +++ b/website/docs/about/_common/HistoryZipAdded/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/docs/about/_common/_history-gnu-arm-eclipse.mdx b/website/docs/about/_common/_history-gnu-arm-eclipse.mdx index be4321e..487c100 100644 --- a/website/docs/about/_common/_history-gnu-arm-eclipse.mdx +++ b/website/docs/about/_common/_history-gnu-arm-eclipse.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/about/_common/_history-rename-xpack.mdx b/website/docs/about/_common/_history-rename-xpack.mdx index cc91640..70b0b14 100644 --- a/website/docs/about/_common/_history-rename-xpack.mdx +++ b/website/docs/about/_common/_history-rename-xpack.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import Link from '@docusaurus/Link'; diff --git a/website/docs/about/_common/_history-restructuring.mdx b/website/docs/about/_common/_history-restructuring.mdx index 2534aeb..9593be8 100644 --- a/website/docs/about/_common/_history-restructuring.mdx +++ b/website/docs/about/_common/_history-restructuring.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/about/_common/_history-setup-discontinued.mdx b/website/docs/about/_common/_history-setup-discontinued.mdx index b2c8e8f..e8b3fff 100644 --- a/website/docs/about/_common/_history-setup-discontinued.mdx +++ b/website/docs/about/_common/_history-setup-discontinued.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import Link from '@docusaurus/Link'; diff --git a/website/docs/about/_common/_history-xbb-v5.mdx b/website/docs/about/_common/_history-xbb-v5.mdx index 1c5a2e3..1277289 100644 --- a/website/docs/about/_common/_history-xbb-v5.mdx +++ b/website/docs/about/_common/_history-xbb-v5.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/about/_common/_intro-primary.mdx b/website/docs/about/_common/_intro-primary.mdx index 0084b81..73dc841 100644 --- a/website/docs/about/_common/_intro-primary.mdx +++ b/website/docs/about/_common/_intro-primary.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/about/_common/_intro-secondary.mdx b/website/docs/about/_common/_intro-secondary.mdx index 41d1c39..e67637c 100644 --- a/website/docs/about/_common/_intro-secondary.mdx +++ b/website/docs/about/_common/_intro-secondary.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/about/_common/_website-docusaurus-migration.mdx b/website/docs/about/_common/_website-docusaurus-migration.mdx index 11fd0fc..36846df 100644 --- a/website/docs/about/_common/_website-docusaurus-migration.mdx +++ b/website/docs/about/_common/_website-docusaurus-migration.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/about/_common/_website-docusaurus-template.mdx b/website/docs/about/_common/_website-docusaurus-template.mdx index abd8f6d..97fbeff 100644 --- a/website/docs/about/_common/_website-docusaurus-template.mdx +++ b/website/docs/about/_common/_website-docusaurus-template.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/about/_common/_website-jekyll.mdx b/website/docs/about/_common/_website-jekyll.mdx index 571cff7..6af9d45 100644 --- a/website/docs/about/_common/_website-jekyll.mdx +++ b/website/docs/about/_common/_website-jekyll.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/about/index.mdx b/website/docs/about/index.mdx index 0064c38..5f992bd 100644 --- a/website/docs/about/index.mdx +++ b/website/docs/about/index.mdx @@ -1,7 +1,7 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: About description: Details about the project, including its history, the history of the website, and details about the author. diff --git a/website/docs/developer/_common/_platform-docker-section.mdx b/website/docs/developer/_common/_platform-docker-section.mdx index 2ee05b8..d23a37b 100644 --- a/website/docs/developer/_common/_platform-docker-section.mdx +++ b/website/docs/developer/_common/_platform-docker-section.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import CodeBlock from '@theme/CodeBlock'; diff --git a/website/docs/developer/_common/_platform-native-section.mdx b/website/docs/developer/_common/_platform-native-section.mdx index 6cd4e81..6a65a41 100644 --- a/website/docs/developer/_common/_platform-native-section.mdx +++ b/website/docs/developer/_common/_platform-native-section.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import CodeBlock from '@theme/CodeBlock'; diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx index fbe263d..3692fce 100644 --- a/website/docs/developer/index.mdx +++ b/website/docs/developer/index.mdx @@ -1,7 +1,7 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: Contributor's Guide description: Guidance for developers aiming to contribute new features or bug fixes, detailing how to build the binaries, including prerequisites, repositories utilised, and scripts. diff --git a/website/docs/faq/_common/_flatpack-snap.mdx b/website/docs/faq/_common/_flatpack-snap.mdx index 705ede4..46d445a 100644 --- a/website/docs/faq/_common/_flatpack-snap.mdx +++ b/website/docs/faq/_common/_flatpack-snap.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import Link from '@docusaurus/Link'; diff --git a/website/docs/faq/_common/_nixos.mdx b/website/docs/faq/_common/_nixos.mdx index f35f026..b506eb0 100644 --- a/website/docs/faq/_common/_nixos.mdx +++ b/website/docs/faq/_common/_nixos.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import Link from '@docusaurus/Link'; diff --git a/website/docs/getting-started/_common/_gcc-release-schedule.mdx b/website/docs/getting-started/_common/_gcc-release-schedule.mdx index a33a84b..5d57ad2 100644 --- a/website/docs/getting-started/_common/_gcc-release-schedule.mdx +++ b/website/docs/getting-started/_common/_gcc-release-schedule.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import versionMajor from '@site/src/libs/versionMajor'; diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx index 2869441..0cc2102 100644 --- a/website/docs/getting-started/index.mdx +++ b/website/docs/getting-started/index.mdx @@ -1,7 +1,7 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: Getting Started description: The initial steps to explore the project, including what xpacks are, the project's features, benefits, compatibility, and available documentation. diff --git a/website/docs/install/_common/_automatic-install-quick-test.mdx b/website/docs/install/_common/_automatic-install-quick-test.mdx index 2588987..b2870ce 100644 --- a/website/docs/install/_common/_automatic-install-quick-test.mdx +++ b/website/docs/install/_common/_automatic-install-quick-test.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; diff --git a/website/docs/install/_common/_manual-install-quick-test.mdx b/website/docs/install/_common/_manual-install-quick-test.mdx index 8a81d21..ce66255 100644 --- a/website/docs/install/_common/_manual-install-quick-test.mdx +++ b/website/docs/install/_common/_manual-install-quick-test.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx index 0da36dd..d345484 100644 --- a/website/docs/install/index.mdx +++ b/website/docs/install/index.mdx @@ -1,7 +1,7 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: Install Guide description: Explain the prerequisites, how to perform an automated or manual installation, how to uninstall, and the folder hierarchies. diff --git a/website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx b/website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx index 794f611..602135f 100644 --- a/website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx +++ b/website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import customField from '@site/src/libs/customField'; diff --git a/website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx b/website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx index bed6f60..71411b2 100644 --- a/website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx +++ b/website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import customField from '@site/src/libs/customField'; diff --git a/website/docs/maintainer/_common/_gcc-check-upstream-release.mdx b/website/docs/maintainer/_common/_gcc-check-upstream-release.mdx index 34fd01a..d46c365 100644 --- a/website/docs/maintainer/_common/_gcc-check-upstream-release.mdx +++ b/website/docs/maintainer/_common/_gcc-check-upstream-release.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/maintainer/_common/_platform-docker-build.mdx b/website/docs/maintainer/_common/_platform-docker-build.mdx index 729cc91..70020d9 100644 --- a/website/docs/maintainer/_common/_platform-docker-build.mdx +++ b/website/docs/maintainer/_common/_platform-docker-build.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import CodeBlock from '@theme/CodeBlock'; diff --git a/website/docs/maintainer/_common/_platform-native-build.mdx b/website/docs/maintainer/_common/_platform-native-build.mdx index 73b934d..f57b56e 100644 --- a/website/docs/maintainer/_common/_platform-native-build.mdx +++ b/website/docs/maintainer/_common/_platform-native-build.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import CodeBlock from '@theme/CodeBlock'; diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx index 5a6ae2a..4a521ee 100644 --- a/website/docs/maintainer/index.mdx +++ b/website/docs/maintainer/index.mdx @@ -1,7 +1,7 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: Maintainer's Guide description: Assistance for project maintainers, including the release schedule, versioning scheme, and instructions on how to build, test, and publish. diff --git a/website/docs/releases/index.md b/website/docs/releases/index.md index f3982c0..e6f4955 100644 --- a/website/docs/releases/index.md +++ b/website/docs/releases/index.md @@ -1,7 +1,7 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: Releases description: The full list of project releases. diff --git a/website/docs/support/index.mdx b/website/docs/support/index.mdx index cc26c86..85c97cd 100644 --- a/website/docs/support/index.mdx +++ b/website/docs/support/index.mdx @@ -1,7 +1,7 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: Help Centre description: The project's support channel, where you can ask questions, start discussions, and report issues. diff --git a/website/docs/test/index.mdx b/website/docs/test/index.mdx index c51d408..837975d 100644 --- a/website/docs/test/index.mdx +++ b/website/docs/test/index.mdx @@ -1,17 +1,23 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: A test page description: Some markdown examples. +unlisted: true + something: "Some text" # https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import Heading from '@theme/Heading'; + import CodeBlock from '@theme/CodeBlock'; export const world = 'World' @@ -62,7 +68,7 @@ Eight :::note -Some **content** with _Markdown_ `syntax`. Check [this `api`](#). +Some white **content** with _Markdown_ `syntax`. Check [this `api`](#). ::: @@ -72,30 +78,32 @@ Some **content** with _Markdown_ `syntax`. Check [this `api`](#). ::: -:::tip +:::info -Some **content** with _Markdown_ `syntax`. Check [this `api`](#). +Some blue **content** with _Markdown_ `syntax`. Check [this `api`](#). ::: -:::info +:::tip -Some **content** with _Markdown_ `syntax`. Check [this `api`](#). +Some green **content** with _Markdown_ `syntax`. Check [this `api`](#). ::: :::caution -Some **content** with _Markdown_ `syntax`. Check [this `api`](#). +Some orange **content** with _Markdown_ `syntax`. Check [this `api`](#). ::: :::danger -Some **content** with _Markdown_ `syntax`. Check [this `api`](#). +Some red **content** with _Markdown_ `syntax`. Check [this `api`](#). ::: +Jekyll `{% include note.html` must be replaced by `:::info`. + --- ## Expandable details @@ -149,3 +157,53 @@ const visit = require('unist-util-visit'); 21 directories, 62 files `} +--- + +## Tabs + + + + + +... + + + + + +... + + + + + +... + + + + + +## 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/_common/_libraries-and-rpath.mdx b/website/docs/user/_common/_libraries-and-rpath.mdx index 89c04b1..ae57b9a 100644 --- a/website/docs/user/_common/_libraries-and-rpath.mdx +++ b/website/docs/user/_common/_libraries-and-rpath.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} {/* ------------------------------------------------------------------------ */} diff --git a/website/docs/user/_common/_versioning.mdx b/website/docs/user/_common/_versioning.mdx index fb19384..2f0d930 100644 --- a/website/docs/user/_common/_versioning.mdx +++ b/website/docs/user/_common/_versioning.mdx @@ -1,5 +1,5 @@ {/* DO NOT EDIT! */} -{/* Automatically generated from xbb-helper/templates/docusaurus/common. */} +{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */} import CodeBlock from '@theme/CodeBlock'; import Admonition from '@theme/Admonition'; diff --git a/website/docs/user/index.mdx b/website/docs/user/index.mdx index ef68efd..74cdf98 100644 --- a/website/docs/user/index.mdx +++ b/website/docs/user/index.mdx @@ -1,7 +1,7 @@ --- # DO NOT EDIT! -# Automatically generated from xbb-helper/templates/docusaurus/common. +# Automatically generated from docusaurus-template-liquid/templates/docusaurus. title: User's Guide description: User information, including the versioning scheme, usage of shared libraries, and RPATH configuration on GNU/Linux. diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 5a00efd..2c5c758 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -1,5 +1,5 @@ // DO NOT EDIT! -// Automatically generated from xbb-helper/templates/docusaurus/common. +// Automatically generated from docusaurus-template-liquid/templates/docusaurus. import {themes as prismThemes} from 'prism-react-renderer'; import type {Config} from '@docusaurus/types'; @@ -146,7 +146,6 @@ const config: Config = { 'https://github.com/xpack-dev-tools/aarch64-none-elf-gcc-xpack/edit/xpack/website/', showLastUpdateTime: true, blogSidebarCount: 8, - authorsMapPath: '../authors.yml', }, theme: { customCss: './src/css/custom.css', diff --git a/website/sidebars.ts b/website/sidebars.ts index e6eda4d..b93728a 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -1,5 +1,5 @@ // DO NOT EDIT! -// Automatically generated from xbb-helper/templates/docusaurus/common. +// Automatically generated from docusaurus-template-liquid/templates/docusaurus. import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; diff --git a/website/src/components/HeadTitle/index.tsx b/website/src/components/HeadTitle/index.tsx index b157048..e93c270 100644 --- a/website/src/components/HeadTitle/index.tsx +++ b/website/src/components/HeadTitle/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/src/components/HomepageFeatures/index.tsx b/website/src/components/HomepageFeatures/index.tsx index 9cd4a59..8f35a5f 100644 --- a/website/src/components/HomepageFeatures/index.tsx +++ b/website/src/components/HomepageFeatures/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/src/components/HomepageFeatures/styles.module.css b/website/src/components/HomepageFeatures/styles.module.css index 44cf5db..17bb861 100644 --- a/website/src/components/HomepageFeatures/styles.module.css +++ b/website/src/components/HomepageFeatures/styles.module.css @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. */ .features { diff --git a/website/src/components/InstallWithCopy/index.tsx b/website/src/components/InstallWithCopy/index.tsx index 0f5cf03..bf84039 100644 --- a/website/src/components/InstallWithCopy/index.tsx +++ b/website/src/components/InstallWithCopy/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/src/components/LinksVsForwarders/index.tsx b/website/src/components/LinksVsForwarders/index.tsx index 9b5d034..adfa92d 100644 --- a/website/src/components/LinksVsForwarders/index.tsx +++ b/website/src/components/LinksVsForwarders/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/src/components/ReleasesList/index.tsx b/website/src/components/ReleasesList/index.tsx index 3fd7466..a81c348 100644 --- a/website/src/components/ReleasesList/index.tsx +++ b/website/src/components/ReleasesList/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. @@ -23,11 +23,17 @@ export function ReleasesList({items}): JSX.Element { return ( ) diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 74f3f6e..1a8b463 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -1,6 +1,6 @@ /** * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * Any CSS included here will be global. The classic template * bundles Infima by default. Infima is a CSS framework designed to @@ -52,6 +52,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; */ @@ -93,6 +97,46 @@ h2[class*="title"] no-repeat; } +.sub-web-home-link::before { + content: ''; + width: 26px; + height: 26px; + display: inline-flex; + vertical-align: top; + padding-right: 0.5em; + background: url("/img/web.svg") no-repeat; +} + +[data-theme='dark'] .sub-web-home-link::before { + content: ''; + width: 26px; + height: 26px; + display: inline-flex; + vertical-align: top; + padding-right: 0.5em; + background: url("/img/web-dark.svg") no-repeat; +} + +.sub-web-github-link::before { + content: ''; + width: 24px; + height: 24px; + display: inline-flex; + vertical-align: top; + padding-right: 0.5em; + background: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; +} + +[data-theme='dark'] .sub-web-github-link::before { + content: ''; + width: 24px; + height: 24px; + display: inline-flex; + vertical-align: top; + padding-right: 0.5em; + background: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath fill='%23fff' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; +} + .getting-started-link::before { content: ''; width: 36px; diff --git a/website/src/libs/customField.ts b/website/src/libs/customField.ts new file mode 100644 index 0000000..8b2dbb1 --- /dev/null +++ b/website/src/libs/customField.ts @@ -0,0 +1,19 @@ +/* + * DO NOT EDIT! + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. + * + * This file is part of the xPack project (http://xpack.github.io). + * Copyright (c) 2024 Liviu Ionescu. All rights reserved. + * + * Permission to use, copy, modify, and/or distribute this software + * for any purpose is hereby granted, under the terms of the MIT license. + * + * If a copy of the license was not distributed with this file, it can + * be obtained from https://opensource.org/licenses/MIT/. + */ + +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; + +export default function customField(name: string): string { + return useDocusaurusContext().siteConfig.customFields[name]; +} diff --git a/website/src/libs/isXpackSubversionDouble.js b/website/src/libs/isXpackSubversionDouble.js index 9ac76cd..04f1880 100644 --- a/website/src/libs/isXpackSubversionDouble.js +++ b/website/src/libs/isXpackSubversionDouble.js @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/src/libs/versionMajor.js b/website/src/libs/versionMajor.js index b9fc61d..31275b2 100644 --- a/website/src/libs/versionMajor.js +++ b/website/src/libs/versionMajor.js @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/src/libs/versionMinor.js b/website/src/libs/versionMinor.js index 5cb62b1..38a634e 100644 --- a/website/src/libs/versionMinor.js +++ b/website/src/libs/versionMinor.js @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/src/pages/index.module.css b/website/src/pages/index.module.css index 591c6d8..12ebf37 100644 --- a/website/src/pages/index.module.css +++ b/website/src/pages/index.module.css @@ -1,6 +1,6 @@ /** * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * CSS files with the .module.css suffix will be treated as CSS modules * and scoped locally. diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index 12f57a4..15a9a46 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. diff --git a/website/src/plugins/SelectReleasesPlugin.js b/website/src/plugins/SelectReleasesPlugin.js index 9cebea3..1957674 100644 --- a/website/src/plugins/SelectReleasesPlugin.js +++ b/website/src/plugins/SelectReleasesPlugin.js @@ -1,6 +1,6 @@ /* * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. + * Automatically generated from docusaurus-template-liquid/templates/docusaurus. * * This file is part of the xPack project (http://xpack.github.io). * Copyright (c) 2024 Liviu Ionescu. All rights reserved. @@ -12,7 +12,7 @@ * be obtained from https://opensource.org/licenses/MIT/. */ -import util from 'util' +import util from 'util'; // https://github.com/facebook/docusaurus/pull/9931 @@ -31,7 +31,7 @@ export default async function SelectReleasesPlugin(context, options) { blogPosts.forEach(post => { // console.log('SelectReleasesPlugin 3 ' + util.inspect(post.metadata.tags)) post.metadata.tags.forEach(tag => { - if (tag.label === 'releases') { + if (tag.label.toLowerCase() === 'releases') { const permalink = post.metadata.permalink.endsWith('/') ? post.metadata.permalink : post.metadata.permalink + '/' diff --git a/website/static/img/web-dark.svg b/website/static/img/web-dark.svg new file mode 100644 index 0000000..eda3c1b --- /dev/null +++ b/website/static/img/web-dark.svg @@ -0,0 +1 @@ + diff --git a/website/static/img/web.svg b/website/static/img/web.svg new file mode 100644 index 0000000..e23dd1d --- /dev/null +++ b/website/static/img/web.svg @@ -0,0 +1 @@ + diff --git a/website/tsconfig.json b/website/tsconfig.json index 6bbddd2..532244b 100644 --- a/website/tsconfig.json +++ b/website/tsconfig.json @@ -1,6 +1,6 @@ { // DO NOT EDIT! - // Automatically generated from xbb-helper/templates/docusaurus/common. + // Automatically generated from docusaurus-template-liquid/templates/docusaurus. // This file is not used in compilation. It is here just for a nice editor experience. "extends": "@docusaurus/tsconfig",