website: more rework with commons

ilg-ul · ilg-ul · commit ac2acae6681a · 2025-01-30T10:55:17.000+02:00
diff --git a/website/customFields.ts b/website/customFields.ts
@@ -24,6 +24,7 @@ export function getCustomFields() {
   const releaseSemver = releaseVersion.replace(/[-].*$/, '');
 
   let upstreamVersion = releaseSemver;
+
   if (releaseSemver.endsWith('.0')) {
     // Remove the patch number if zero (wine uses both 2 and 3 numbers).
     upstreamVersion = releaseSemver.replace(/[.]0*$/, '');
diff --git a/website/docs/developer/_common/_content.mdx b/website/docs/developer/_common/_content.mdx
@@ -282,6 +282,7 @@ git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull
 ### Build the binaries
 
 <Tabs groupId="platforms">
+
 <TabItem value="darwin-x64" label="macOS x64" default>
 <PlatformNativeSection platform="darwin-x64"/>
 </TabItem>
diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx
@@ -24,7 +24,6 @@ import Content from './_common/_content.mdx';
 [![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/sed-xpack)](https://github.com/xpack-dev-tools/sed-xpack/issues)
 [![GitHub pulls](https://img.shields.io/github/issues-pr/xpack-dev-tools/sed-xpack)](https://github.com/xpack-dev-tools/sed-xpack/pulls/)
 
-
 # How to contribute to  the xPack GNU sed
 
 This page is designed for developers who plan to contribute new features
@@ -33,4 +32,3 @@ or fix bugs in the
 project and provides documentation on how to build and test the package.
 
 <Content />
-
diff --git a/website/docs/faq/index.mdx b/website/docs/faq/index.mdx
@@ -32,4 +32,3 @@ import FlatpackSnap from './_common/_flatpack-snap.mdx';
 <NixOs />
 
 <FlatpackSnap />
-
diff --git a/website/docs/getting-started/_common/_license.mdx b/website/docs/getting-started/_common/_license.mdx
@@ -13,4 +13,3 @@ with all rights reserved to
 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/index.mdx b/website/docs/getting-started/index.mdx
@@ -172,7 +172,7 @@ location, including in user folders.
 The main advantages of using the **xPack GNU sed** are:
 
 - A convenient, uniform and portable install/uninstall/upgrade
-procedure; the same procedure is used for all major
+  procedure; the same procedure is used for all major
   platforms (**x64 macOS**, **arm64 macOS**, **x64 GNU/Linux**, **arm64 GNU/Linux**, **arm GNU/Linux**).
 - Multiple versions of the same package can be installed at the same time on
   the same system.
@@ -241,4 +241,3 @@ The list of releases is available in the [Releases](/docs/releases/) pages.
 <MoreCredits />
 
 <EnjoyedUsing />
-
diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx
@@ -245,6 +245,7 @@ To install a **specific version**, specify it explicitly:
 `} </CodeBlock>
 
 <Tabs groupId="operating-systems">
+
 <TabItem value="macos" label="macOS">
 
 The main result is a set
@@ -395,6 +396,7 @@ the user global xPacks store,
 the project build configurations need a PATH adjustment:
 
 <Tabs groupId="operating-systems">
+
 <TabItem value="macos" label="macOS">
 
 <CodeBlock language="sh"> {
@@ -450,6 +452,7 @@ To completely remove the package from the user global xPacks store:
 For a thorough clean-up, please note that **xpm** uses only two folders:
 
 <Tabs groupId="operating-systems">
+
 <TabItem value="macos" label="macOS">
 
 - `${HOME}/Library/xPacks`
@@ -487,6 +490,7 @@ the <a href={`https://github.com/xpack-dev-tools/sed-xpack/releases`}>GitHub Rel
 ### Download & unpack {#manual-install-download-and-unpack}
 
 <Tabs groupId="operating-systems">
+
 <TabItem value="macos" label="macOS">
 
 The macOS versions of **xPack GNU sed**
@@ -577,6 +581,7 @@ After install, the package creates a hierarchy of folders like the following
 (only the first two depth levels are shown):
 
 <Tabs groupId="operating-systems">
+
 <TabItem value="macos" label="macOS">
 
 <FoldersHierarchiesMacOS />
@@ -594,4 +599,3 @@ After install, the package creates a hierarchy of folders like the following
 <Miscellaneous/>
 
 <Testing/>
-
diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx
@@ -965,4 +965,3 @@ Close those that were addressed.
 Credit to [Shields IO](https://shields.io) for the badges and to
 [Somsubhra/github-release-stats](https://github.com/Somsubhra/github-release-stats)
 for the individual file counters.
-
diff --git a/website/docs/project/about/_common/_the-author.mdx b/website/docs/project/about/_common/_the-author.mdx
@@ -11,7 +11,6 @@ a senior computer engineer, with expertise in **C++/C embedded systems**,
 **RTOSes**, **build tools**, operating systems, compilers
 and Internet technologies.
 
-
 He can be reached at [`<ilg@livius.net>`](mailto:ilg@livius.net).
 Please note, this email address is provided as a courtesy.
 For all correspondence related to the **xPack GNU sed**
diff --git a/website/docs/project/about/index.mdx b/website/docs/project/about/index.mdx
@@ -38,4 +38,3 @@ import TheAuthor from './_common/_the-author.mdx';
 <TheWebsite />
 
 <TheAuthor />
-
diff --git a/website/docs/support/index.mdx b/website/docs/support/index.mdx
@@ -52,8 +52,7 @@ check if the subject was not already addressed.
 for similar problems
 - Check the [GitHub Discussions](https://github.com/xpack-dev-tools/sed-xpack/discussions) for
 similar topics
-- Check the
-[GitHub Issues](https://github.com/xpack-dev-tools/sed-xpack/issues)
+- Check the [GitHub Issues](https://github.com/xpack-dev-tools/sed-xpack/issues)
 tracker and the
 [GitHub Pull Requests](https://github.com/xpack-dev-tools/sed-xpack/pulls)
 for similar problems.
diff --git a/website/docs/user/index.mdx b/website/docs/user/index.mdx
@@ -38,4 +38,3 @@ the **xPack GNU sed** into their workflows.
 <LibrariesAndRpath/>
 
 <UseInTesting/>
-
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -29,6 +29,7 @@ const config: Config = {
   title: 'xPack GNU sed' +
     ((process.env.DOCUSAURUS_IS_PREVIEW === 'true') ? ' (preview)' : ''),
   tagline: 'A binary distribution of GNU sed',
+
   // Explicitly set in headTags.
   // favicon: '/img/favicon.ico',
 
@@ -61,54 +62,74 @@ const config: Config = {
     locales: ['en'],
   },
 
-  presets: [
+  plugins: [
     [
-      'classic',
+      '@docusaurus/plugin-content-docs',
       {
-        docs: {
-          sidebarPath: './sidebars.ts',
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/xpack-dev-tools/sed-xpack/edit/xpack/website/',
-          // showLastUpdateAuthor: true,
-          showLastUpdateTime: true,
-        },
-        blog: {
-          showReadingTime: true,
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/xpack-dev-tools/sed-xpack/edit/xpack/website/',
-          showLastUpdateTime: true,
-          blogSidebarCount: 8,
-        },
-        theme: {
-          customCss: './src/css/custom.css',
-        },
-        // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap
-        sitemap: {
-          lastmod: 'date',
-          changefreq: 'weekly',
-          priority: 0.5,
-          ignorePatterns: [
-            '/sed-xpack/blog/archive/**',
-            '/sed-xpack/blog/authors/**',
-            '/sed-xpack/blog/tags/**'
-          ],
-          filename: 'sitemap.xml',
-        },
-        // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag
-        // https://tagassistant.google.com
-        gtag: {
-          trackingID: 'G-7QE5W7V05S',
-          anonymizeIP: false,
+        sidebarPath: './sidebars.ts',
+        // Please change this to your repo.
+        // Remove this to remove the "edit this page" links.
+        editUrl: 'https://github.com/xpack-dev-tools/sed-xpack/edit/website/website/',
+        // showLastUpdateAuthor: true,
+        showLastUpdateTime: true,
+      },
+    ],
+    [
+      // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog
+      '@docusaurus/plugin-content-blog',
+      {
+        showReadingTime: true,
+        blogSidebarCount: 8,
+        feedOptions: {
+          type: ['rss', 'atom'],
+          xslt: true,
         },
-      } satisfies Preset.Options,
+        // Please change this to your repo.
+        // Remove this to remove the "edit this page" links.
+        editUrl: 'https://github.com/xpack-dev-tools/sed-xpack/edit/website/website/',
+        // Useful options to enforce blogging best practices
+        onInlineTags: 'warn',
+        onInlineAuthors: 'warn',
+        onUntruncatedBlogPosts: 'warn',
+      },
+    ],
+    [
+      '@docusaurus/plugin-content-pages',
+      {}
+    ],
+    [
+      // https://docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-client-redirects#redirects
+      '@docusaurus/plugin-client-redirects',
+      redirects,
+    ],
+    [
+      '@docusaurus/plugin-debug',
+      {}
+    ],
+    [
+      // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag
+      // https://tagassistant.google.com
+      '@docusaurus/plugin-google-gtag',
+      {
+        trackingID: 'G-7QE5W7V05S',
+        anonymizeIP: false,
+      }
+    ],
+    [
+      // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap
+      '@docusaurus/plugin-sitemap',
+      {
+        lastmod: 'date',
+        changefreq: 'weekly',
+        priority: 0.5,
+        ignorePatterns: [
+          actualBaseUrl + 'blog/archive/**',
+          actualBaseUrl + 'blog/authors/**',
+          actualBaseUrl + 'blog/tags/**'
+        ],
+        filename: 'sitemap.xml',
+      }
     ],
-  ],
-
-  plugins: [
     [
       '@docusaurus/plugin-ideal-image',
       {
@@ -119,12 +140,25 @@ const config: Config = {
         disableInDev: false,
       },
     ],
+
+    // Local plugins.
+    './src/plugins/SelectReleasesPlugin',
+  ],
+
+  themes: [
     [
-      // https://docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-client-redirects#redirects
-      '@docusaurus/plugin-client-redirects',
-      redirects
+      '@docusaurus/theme-classic',
+      {
+        customCss: './src/css/custom.css',
+      }
+    ],
+    [
+      // Explicitly required when not using `preset-classic`.
+      // https://docusaurus.io/docs/search#using-algolia-docsearch
+      '@docusaurus/theme-search-algolia',
+      {
+      }
     ],
-    './src/plugins/SelectReleasesPlugin',
   ],
 
   // https://docusaurus.io/docs/api/docusaurus-config#headTags
@@ -170,9 +204,6 @@ const config: Config = {
     }
   ],
 
-  // No longer needed.
-  // themes: [ '@docusaurus/theme-search-algolia' ],
-
   // https://docusaurus.io/docs/seo
   themeConfig: {
     // The project's social card, og:image, twitter:image, 1200x630
@@ -241,9 +272,8 @@ const config: Config = {
               label: 'About',
               to: '/docs/project/about'
             },
-          ]
+          ],
         },
-        
         {
           type: 'dropdown',
           to: '/blog',
@@ -280,14 +310,14 @@ const config: Config = {
               label: `sed-xpack project`,
               href: `https://github.com/xpack-dev-tools/sed-xpack/`,
             },
-            {
-              label: 'xpack-dev-tools org',
-              href: 'https://github.com/xpack-dev-tools/',
-            },
             {
               label: 'xpack org',
               href: 'https://github.com/xpack/',
             },
+            {
+              label: 'xpack-dev-tools org',
+              href: 'https://github.com/xpack-dev-tools/',
+            },
           ]
         },
         {
@@ -304,17 +334,17 @@ const config: Config = {
           title: 'Pages',
           items: [
             {
-              label: 'Install',
-              to: '/docs/install',
-            },
-            {
-              label: 'Support',
-              to: '/docs/support',
+              label: 'Getting Started',
+              to: '/docs/getting-started',
             },
             {
               label: 'Releases',
               to: '/docs/releases',
             },
+            {
+              label: 'About',
+              to: '/docs/project/about',
+            },
             {
               label: 'Blog',
               to: '/blog',
@@ -334,7 +364,7 @@ const config: Config = {
             },
             {
               label: 'Discord',
-              href: 'https://discord.gg/kbzWaJerFG',
+              href: 'https://discord.com/invite/kbzWaJerFG',
             },
             {
               label: 'X/Twitter',
@@ -353,14 +383,14 @@ const config: Config = {
               label: 'GitHub sed-xpack project',
               href: 'https://github.com/xpack-dev-tools/sed-xpack/',
             },
-            {
-              label: 'GitHub xpack-dev-tools org',
-              href: 'https://github.com/xpack-dev-tools/',
-            },
             {
               label: 'GitHub xpack org',
               href: 'https://github.com/xpack/',
             },
+            {
+              label: 'GitHub xpack-dev-tools org',
+              href: 'https://github.com/xpack-dev-tools/',
+            },
           ],
         },
       ],
diff --git a/website/package-lock.json b/website/package-lock.json
diff --git a/website/package.json b/website/package.json
diff --git a/website/sidebars.ts b/website/sidebars.ts
diff --git a/website/src/components/HomepageFeatures/index.tsx b/website/src/components/HomepageFeatures/index.tsx
diff --git a/website/src/css/custom.css b/website/src/css/custom.css

Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,3 @@ import FlatpackSnap from './_common/_flatpack-snap.mdx';`
`32`	`32`	`<NixOs />`
`33`	`33`
`34`	`34`	`<FlatpackSnap />`
`35`		`-`
Original file line number	Diff line number	Diff line change
`@@ -38,4 +38,3 @@ import TheAuthor from './_common/_the-author.mdx';`
`38`	`38`	`<TheWebsite />`
`39`	`39`
`40`	`40`	`<TheAuthor />`
`41`		`-`