website: re-generate commons

xpack-dev-tools · Jan 16, 2025 · 772b706 · 772b706
1 parent 2c0635e
commit 772b706
Show file tree

Hide file tree

Showing 54 changed files with 170 additions and 57 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,14 @@
+# DO NOT EDIT!
+# Automatically generated from docusaurus-template-liquid/templates/docusaurus.
+
+ilg-ul:
+  name: Liviu Ionescu (ilg)
+  email: [email protected]
+  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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/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 Guides
 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/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
@@ -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/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 Guides
 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/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 Guides
 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/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 Guides
 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
@@ -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/xpack-dev-tools.github.io-xpack/edit/xpack/website/',
           showLastUpdateTime: true,
           blogSidebarCount: 8,
-          authorsMapPath: '../authors.yml',
         },
         theme: {
           customCss: './src/css/custom.css',

diff --git a/website/package.json b/website/package.json
@@ -56,7 +56,9 @@
       "last 5 safari version"
     ]
   },
-  "websiteConfig": {},
+  "websiteConfig": {
+    "skipInstallCommand": "true"
+  },
   "engines": {
     "node": ">=18.0"
   }

diff --git 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
@@ -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
@@ -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
@@ -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/HomepageTools/index.tsx b/website/src/components/HomepageTools/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/HomepageTools/styles.module.css b/website/src/components/HomepageTools/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
@@ -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
@@ -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
@@ -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 (
     <ul>
       {
-        pluginData.releasesTable.map(release => (
-          <li>
-            <a href={release.permalink}>{release.title}</a> (<a href={release.downloadUrl}>download</a>)
-          </li>
-        ))
+        pluginData.releasesTable.length > 0 ?
+          pluginData.releasesTable.map(release => (
+            <li>
+              <a href={release.permalink}>{release.title}</a> {release.downloadUrl === "true" ? (<>(<a href={release.downloadUrl}>download</a>)</>) : (<></>)}
+            </li>
+          )) :
+          (
+            <li>
+              none yet
+            </li>
+          )
       }
     </ul>
   )