website: more rework with commons

ilg-ul · ilg-ul · commit eb0432e4be2f · 2025-01-29T00:14:45.000+02:00
diff --git a/website/docs/developer/_common/_content.mdx b/website/docs/developer/_common/_content.mdx
@@ -8,8 +8,6 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 
-import customField from '@site/src/libs/customField';
-
 import PlatformNativeSection from './_platform-native-section.mdx';
 import PlatformDockerSection from './_platform-docker-section.mdx';
 import OtherRepositories from '../_project/_other-repositories.mdx';
diff --git a/website/docs/developer/_common/_platform-docker-section.mdx b/website/docs/developer/_common/_platform-docker-section.mdx
@@ -3,7 +3,6 @@
 
 import CodeBlock from '@theme/CodeBlock';
 
-import customField from '@site/src/libs/customField';
 import {developmentDurations} from '../../_shared/_development-durations.mdx';
 
 {/* ------------------------------------------------------------------------ */}
diff --git a/website/docs/developer/_common/_platform-native-section.mdx b/website/docs/developer/_common/_platform-native-section.mdx
@@ -3,7 +3,6 @@
 
 import CodeBlock from '@theme/CodeBlock';
 
-import customField from '@site/src/libs/customField';
 import {developmentDurations} from '../../_shared/_development-durations.mdx';
 
 {/* ------------------------------------------------------------------------ */}
diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx
@@ -12,7 +12,7 @@ keywords:
   - repositories
   - build
 
-date: 2024-07-21 20:33:00 +0300
+date: 2024-10-25 13:10:00 +0300
 
 ---
 
@@ -24,6 +24,7 @@ import Content from './_common/_content.mdx';
 [![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/mingw-w64-gcc-xpack)](https://github.com/xpack-dev-tools/mingw-w64-gcc-xpack/issues)
 [![GitHub pulls](https://img.shields.io/github/issues-pr/xpack-dev-tools/mingw-w64-gcc-xpack)](https://github.com/xpack-dev-tools/mingw-w64-gcc-xpack/pulls/)
 
+
 # How to contribute to  the xPack MinGW-w64 GCC
 
 This page is designed for developers who plan to contribute new features
diff --git a/website/docs/getting-started/_common/_credits.mdx b/website/docs/getting-started/_common/_credits.mdx
@@ -0,0 +1,17 @@
+{/* DO NOT EDIT! */}
+{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
+
+import Link from '@docusaurus/Link';
+
+{/* ------------------------------------------------------------------------ */}
+
+<Link to="https://www.macstadium.com/"><img className="mac-stadium-img" alt="MacStadium" src="https://uploads-ssl.webflow.com/5ac3c046c82724970fc60918/5c019d917bba312af7553b49_MacStadium-developerlogo.png"></img></Link>
+
+## Credits
+
+Special thanks to **MacStadium**, for providing the Apple Silicon
+development infrastructure as part of their generous
+[Free and Open Source Software](https://www.macstadium.com/company/opensource)
+program.
+
+Thanks to [Shields IO](https://shields.io) for the badges.
diff --git a/website/docs/getting-started/_common/_enjoyed-using.mdx b/website/docs/getting-started/_common/_enjoyed-using.mdx
@@ -0,0 +1,12 @@
+{/* DO NOT EDIT! */}
+{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
+
+{/* ------------------------------------------------------------------------ */}
+
+## Enjoyed Using This Project? Let Us Know!
+
+If you enjoyed using this project, please let us know! Here are some ways you can show your support:
+
+- **Donate**: Your contributions, whether small or generous, help us keep the xPack projects thriving. [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate/?hosted_button_id=5MFRG9ZRBETQ8)
+- **Star** the project on [GitHub](https://github.com/xpack-dev-tools/mingw-w64-gcc-xpack/): It helps others discover our work.
+- **Follow** us on [X/Twitter](https://twitter.com/xpack_project/): Stay updated with our latest releases and news.
diff --git a/website/docs/getting-started/_common/_license.mdx b/website/docs/getting-started/_common/_license.mdx
@@ -0,0 +1,16 @@
+{/* DO NOT EDIT! */}
+{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
+
+{/* ------------------------------------------------------------------------ */}
+
+## License
+
+The original content is released under the
+[MIT License](https://opensource.org/license/mit/),
+with all rights reserved to
+[Liviu Ionescu](https://github.com/ilg-ul).
+
+The binary distributions include several open-source components; the
+corresponding licenses are available in each archive in the
+`distro-info/licenses` folder.
+
diff --git a/website/docs/getting-started/_project/_more-credits.mdx b/website/docs/getting-started/_project/_more-credits.mdx
@@ -0,0 +1,2 @@
+
+{/* ------------------------------------------------------------------------ */}
diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx
@@ -28,6 +28,11 @@ import OtherBenefits from './_project/_other-benefits.mdx';
 import UpgradeNotice from './_project/_upgrade-notice.mdx';
 import Compatibility from './_project/_compatibility.mdx';
 
+import License from './_common/_license.mdx';
+import Credits from './_common/_credits.mdx';
+import MoreCredits from './_project/_more-credits.mdx';
+import EnjoyedUsing from './_common/_enjoyed-using.mdx';
+
 import ReleaseSchedule from '../_shared/_release-schedule.mdx';
 
 {/* ------------------------------------------------------------------------ */}
@@ -225,37 +230,15 @@ all available from the
 [`mingw-w64-gcc-xpack.git/build-assets/scripts`](https://github.com/xpack-dev-tools/mingw-w64-gcc-xpack/tree/xpack/build-assets/scripts/)
 folder. The scripts include common code from the [`@xpack-dev-tools/xbb-helper`](https://github.com/xpack-dev-tools/xbb-helper-xpack) package.
 
-## License
-
-Unless otherwise stated, the original content is released under the terms of the
-[MIT License](https://opensource.org/licenses/mit/),
-with all rights reserved to
-[Liviu Ionescu](https://github.com/ilg-ul).
-
-The binary distributions include several open-source components; the
-corresponding licenses are available in each archive in the
-`distro-info/licenses` folder.
+<License />
 
 ## Releases
 
 The list of releases is available in the [Releases](/docs/releases/) pages.
 
-<Link to="https://www.macstadium.com/"><img className="mac-stadium-img" alt="MacStadium" src="https://uploads-ssl.webflow.com/5ac3c046c82724970fc60918/5c019d917bba312af7553b49_MacStadium-developerlogo.png"></img></Link>
-
-## Credits
-
-Special thanks to **MacStadium**, for providing the Apple Silicon
-development infrastructure as part of their generous
-[Free and Open Source Software](https://www.macstadium.com/company/opensource)
-program.
-
-Thanks to [Shields IO](https://shields.io) for the badges.
+<Credits />
 
-## Enjoyed Using This Project? Let Us Know!
+<MoreCredits />
 
-If you enjoyed using this project, please let us know! Here are some ways you can show your support:
+<EnjoyedUsing />
 
-- **Donate**: Your contributions (small or
-generous) help us keep the xPack projects thriving. [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate/?hosted_button_id=5MFRG9ZRBETQ8)
-- **Star** the project on [GitHub](https://github.com/xpack-dev-tools/mingw-w64-gcc-xpack/): It helps others discover our work.
-- **Follow** us on [X/Twitter](https://twitter.com/xpack_project/): Stay updated with our latest releases and news.
diff --git a/website/docs/install/_common/_automatic-install-quick-test.mdx b/website/docs/install/_common/_automatic-install-quick-test.mdx
@@ -5,8 +5,6 @@ import CodeBlock from '@theme/CodeBlock';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-import customField from '@site/src/libs/customField';
-
 {/* ------------------------------------------------------------------------ */}
 
 ### Quick test
diff --git a/website/docs/install/_common/_manual-install-quick-test.mdx b/website/docs/install/_common/_manual-install-quick-test.mdx
@@ -5,8 +5,6 @@ import CodeBlock from '@theme/CodeBlock';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-import customField from '@site/src/libs/customField';
-
 {/* ------------------------------------------------------------------------ */}
 
 ### Quick test {#manual-install-quick-test}
diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx
@@ -23,7 +23,6 @@ import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 import Admonition from '@theme/Admonition';
 
-import customField from '@site/src/libs/customField';
 import LinksVsForwarders from '@site/src/components/LinksVsForwarders';
 
 import AutomaticInstallQuickTest from './_common/_automatic-install-quick-test.mdx';
diff --git a/website/docs/maintainer/_common/_platform-docker-build.mdx b/website/docs/maintainer/_common/_platform-docker-build.mdx
@@ -3,8 +3,6 @@
 
 import CodeBlock from '@theme/CodeBlock';
 
-import customField from '@site/src/libs/customField';
-
 import {developmentDurations} from '../../_shared/_development-durations.mdx';
 
 {/* ------------------------------------------------------------------------ */}
diff --git a/website/docs/maintainer/_common/_platform-native-build.mdx b/website/docs/maintainer/_common/_platform-native-build.mdx
@@ -3,8 +3,6 @@
 
 import CodeBlock from '@theme/CodeBlock';
 
-import customField from '@site/src/libs/customField';
-
 import {developmentDurations} from '../../_shared/_development-durations.mdx';
 
 {/* ------------------------------------------------------------------------ */}
diff --git a/website/docs/project/history/_common/HistoryXpm/index.tsx b/website/docs/project/history/_common/HistoryXpm/index.tsx
@@ -12,8 +12,6 @@
  * be obtained from https://opensource.org/licenses/MIT/.
  */
 
-import customField from '@site/src/libs/customField';
-
 export default function HistoryXpm({specifier}): JSX.Element {
     return (
         <>The xPack metadata has been added, and the package can now be more conveniently installed via <b>xpm</b>. It is  available from <code>npmjs.com</code> as <code>{specifier ? specifier : '@xpack-dev-tools/mingw-w64-gcc'}</code></>
diff --git a/website/docs/user/_common/_versioning.mdx b/website/docs/user/_common/_versioning.mdx
@@ -4,8 +4,6 @@
 import CodeBlock from '@theme/CodeBlock';
 import Admonition from '@theme/Admonition';
 
-import customField from '@site/src/libs/customField';
-
 import LinksVsForwarders from '@site/src/components/LinksVsForwarders';
 
 {/* ------------------------------------------------------------------------ */}
diff --git a/website/docs/user/index.mdx b/website/docs/user/index.mdx
@@ -18,8 +18,6 @@ date: 2024-07-21 18:56:00 +0300
 
 ---
 
-import customField from '@site/src/libs/customField';
-
 import Versioning from './_project/_versioning.mdx';
 import LibrariesAndRpath from './_common/_libraries-and-rpath.mdx';
 import UseInTesting from './_project/_use-in-testing.mdx';
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -20,6 +20,9 @@ import {getCustomFields} from './customFields';
 const customFields = getCustomFields();
 console.log('customFields: ' + util.inspect(customFields));
 
+const actualBaseUrl = process.env.DOCUSAURUS_BASEURL ??
+    '/mingw-w64-gcc-xpack/';
+
 // ----------------------------------------------------------------------------
 
 const config: Config = {
@@ -30,11 +33,10 @@ const config: Config = {
   // favicon: '/img/favicon.ico',
 
   // Set the production url of your site here
-  url: 'https://xpack-dev-tools.github.io',
+  url: 'https://xpack-dev-tools.github.io/',
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
-  baseUrl: process.env.DOCUSAURUS_BASEURL ??
-    '/mingw-w64-gcc-xpack/',
+  baseUrl: actualBaseUrl,
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
@@ -132,7 +134,7 @@ const config: Config = {
       attributes: {
         rel: 'icon',
         type: 'image/png',
-        href: '/mingw-w64-gcc-xpack/favicons/favicon-48x48.png',
+        href: actualBaseUrl + 'favicons/favicon-48x48.png',
         sizes: '48x48'
       }
     },
@@ -141,14 +143,14 @@ const config: Config = {
       attributes: {
         rel: 'icon',
         type: 'image/svg+xml',
-        href: '/mingw-w64-gcc-xpack/favicons/favicon.svg'
+        href: actualBaseUrl + 'favicons/favicon.svg'
       }
     },
     {
       tagName: 'link',
       attributes: {
         rel: 'shortcut icon',
-        href: '/mingw-w64-gcc-xpack/favicons/favicon.ico'
+        href: actualBaseUrl + 'favicons/favicon.ico'
       }
     },
     {
@@ -163,7 +165,7 @@ const config: Config = {
       tagName: 'link',
       attributes: {
         rel: 'manifest',
-        href: '/mingw-w64-gcc-xpack/favicons/site.webmanifest'
+        href: actualBaseUrl + 'favicons/site.webmanifest'
       }
     }
   ],
diff --git a/website/src/components/HomepageFeatures/FeatureItem.tsx b/website/src/components/HomepageFeatures/FeatureItem.tsx
@@ -0,0 +1,21 @@
+/*
+ * 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 React from 'react';
+
+export type FeatureItem = {
+  title: string;
+  Svg: React.ComponentType<React.ComponentProps<'svg'>>;
+  description: JSX.Element;
+};
diff --git a/website/src/components/HomepageFeatures/FeatureList.tsx b/website/src/components/HomepageFeatures/FeatureList.tsx
@@ -0,0 +1,56 @@
+/*
+ * 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 Link from '@docusaurus/Link';
+
+import type { FeatureItem } from './FeatureItem';
+
+export const FeatureList: FeatureItem[] = [
+  {
+    title: 'Multi-version, cross-platform',
+    Svg: require('@site/static/img/mosaic.svg').default,
+    description: (
+      <>
+        The <b>xPack Framework</b> aims to automate the installation of <b>multiple versions</b> of development tools that are otherwise not easily available in common software distributions, across multiple platforms (<b>Windows</b>, <b>macOS</b>, <b>GNU/Linux</b>).
+      </>
+    ),
+  },
+  {
+    title: 'Easy to Use & Reproducible',
+    Svg: require('@site/static/img/check-badge.svg').default,
+    description: (
+      <>
+        The binary packages can be added to projects
+        as <b>development dependencies</b>,
+        and conveniently installed with <code>xpm install</code>.
+        This feature also ensures reproducibility, which is particularly
+        beneficial in <b>CI/CD</b> environments.
+      </>
+    ),
+  },
+  {
+    title: 'Part of the Node.js ecosystem',
+    Svg: require('@site/static/img/globe.svg').default,
+    description: (
+      <>
+        The <b><Link to="https://xpack.github.io/xpm/">xpm</Link></b> CLI tool
+        complements <b><Link to="https://docs.npmjs.com/cli/">npm</Link></b> with
+        several extra features specific to <b>C/C++ projects</b>.
+        This allows the
+        binary packages to nicely integrate into the Node.js ecosystem,
+        while still allowing the binary archives to be installed manually.
+      </>
+    ),
+  },
+];
diff --git a/website/src/components/HomepageFeatures/index.tsx b/website/src/components/HomepageFeatures/index.tsx
diff --git a/website/src/libs/versionMajor.ts b/website/src/libs/versionMajor.ts
diff --git a/website/src/libs/versionMinor.ts b/website/src/libs/versionMinor.ts
diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+`
	`2`	`+{/* ------------------------------------------------------------------------ */}`