From 7153d76a8d241e9d819ba1a7852ee7c8d8b9e00f Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Tue, 15 Oct 2024 03:34:16 +0300 Subject: [PATCH] website: updates --- .../2022-10-21-realpath-v9-1-0-1-released.mdx | 6 +- .../2023-01-29-realpath-v9-1-0-2-released.mdx | 6 +- .../2023-09-05-realpath-v9-4-0-1-released.mdx | 6 +- website/docs/about/index.mdx | 7 +- website/docs/developer/index.mdx | 7 +- website/docs/faq/index.mdx | 7 +- website/docs/getting-started/index.mdx | 20 +- website/docs/install/index.mdx | 7 +- website/docs/maintainer/index.mdx | 7 +- website/docs/releases/index.md | 7 +- website/docs/support/index.mdx | 7 +- website/docs/test/index.mdx | 5 +- website/docs/user/index.mdx | 7 +- website/docusaurus.config.ts | 13 +- .../src/components/HomepageTools/index.tsx | 201 ------------------ .../HomepageTools/styles.module.css | 16 -- website/src/pages/index.tsx | 2 +- 17 files changed, 57 insertions(+), 274 deletions(-) delete mode 100644 website/src/components/HomepageTools/index.tsx delete mode 100644 website/src/components/HomepageTools/styles.module.css diff --git a/website/blog/2022-10-21-realpath-v9-1-0-1-released.mdx b/website/blog/2022-10-21-realpath-v9-1-0-1-released.mdx index dc91897..d7fc9d4 100644 --- a/website/blog/2022-10-21-realpath-v9-1-0-1-released.mdx +++ b/website/blog/2022-10-21-realpath-v9-1-0-1-released.mdx @@ -25,8 +25,10 @@ download_url: https://github.com/xpack-dev-tools/realpath-xpack/releases/tag/v9. --- -{frontMatter.title} - + + {frontMatter.title} + + Version **9.1.0-1** is the first release. diff --git a/website/blog/2023-01-29-realpath-v9-1-0-2-released.mdx b/website/blog/2023-01-29-realpath-v9-1-0-2-released.mdx index a1e469e..d74d0fd 100644 --- a/website/blog/2023-01-29-realpath-v9-1-0-2-released.mdx +++ b/website/blog/2023-01-29-realpath-v9-1-0-2-released.mdx @@ -25,8 +25,10 @@ download_url: https://github.com/xpack-dev-tools/realpath-xpack/releases/tag/v9. --- -{frontMatter.title} - + + {frontMatter.title} + + Version **9.1.0-2** is a maintenance release, built with the latest build scripts. diff --git a/website/blog/2023-09-05-realpath-v9-4-0-1-released.mdx b/website/blog/2023-09-05-realpath-v9-4-0-1-released.mdx index d07d3bf..6829d9c 100644 --- a/website/blog/2023-09-05-realpath-v9-4-0-1-released.mdx +++ b/website/blog/2023-09-05-realpath-v9-4-0-1-released.mdx @@ -26,8 +26,10 @@ download_url: https://github.com/xpack-dev-tools/realpath-xpack/releases/tag/v9. --- -{frontMatter.title} - + + {frontMatter.title} + + Version **9.4.0-1** is a new release; it follows the upstream release. diff --git a/website/docs/about/index.mdx b/website/docs/about/index.mdx index 0c9734a..9c864f3 100644 --- a/website/docs/about/index.mdx +++ b/website/docs/about/index.mdx @@ -3,7 +3,7 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: About the xPack GNU realpath +title: About description: Details about the project, including its history, the history of the website, and details about the author. keywords: - xpack @@ -17,9 +17,6 @@ date: 2024-09-22 10:23:00 +0300 --- -{frontMatter.title} - - import customField from '@site/src/libs/customField'; import MoreIntro from './_more-intro.mdx' import History from './_history.mdx' @@ -27,7 +24,7 @@ import Website from './_website.mdx' {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# About the xPack GNU realpath ## The project diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx index 25307d5..a093470 100644 --- a/website/docs/developer/index.mdx +++ b/website/docs/developer/index.mdx @@ -3,7 +3,7 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to build the xPack GNU realpath +title: Developer Information description: Assistance for developers looking to build the packages, including prerequisites, repositories used, and actions for each supported platform. keywords: - xpack @@ -16,9 +16,6 @@ date: 2024-07-21 20:33:00 +0300 --- -{frontMatter.title} - - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import CodeBlock from '@theme/CodeBlock'; @@ -32,7 +29,7 @@ import More from './_more.mdx' {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# How to build the xPack GNU realpath [![license](https://img.shields.io/github/license/xpack-dev-tools/realpath-xpack)](https://github.com/xpack-dev-tools/realpath-xpack/blob/xpack/LICENSE) diff --git a/website/docs/faq/index.mdx b/website/docs/faq/index.mdx index 4c46b90..a73cb77 100644 --- a/website/docs/faq/index.mdx +++ b/website/docs/faq/index.mdx @@ -1,5 +1,5 @@ --- -title: The xPack GNU realpath Frequently Asked Questions +title: FAQ description: Answers to previously asked questions, so you can find solutions without having to ask again. keywords: - xpack @@ -14,16 +14,13 @@ date: 2020-07-21 17:49:00 +0300 --- -{frontMatter.title} - - import More from './_more.mdx' import NixOs from './_common/_nixos.mdx' import FlatpackSnap from './_common/_flatpack-snap.mdx' {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# The xPack GNU realpath Frequently Asked Questions diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx index cd53b0d..e180202 100644 --- a/website/docs/getting-started/index.mdx +++ b/website/docs/getting-started/index.mdx @@ -3,7 +3,7 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: Getting Started with the xPack GNU realpath +title: Getting Started description: The initial steps to explore the project, including what xpacks are, the project's features, benefits, compatibility, and available documentation. keywords: - xpack @@ -19,9 +19,6 @@ date: 2020-07-21 17:49:00 +0300 --- -{frontMatter.title} - - import Link from '@docusaurus/Link'; import Overview from './_overview.mdx'; @@ -33,7 +30,7 @@ import ReleaseSchedule from './_release-schedule.mdx' {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# Getting Started with the xPack GNU realpath [![license](https://img.shields.io/github/license/xpack-dev-tools/realpath-xpack)](https://github.com/xpack-dev-tools/realpath-xpack/blob/xpack/LICENSE) ![GitHub Repo stars](https://img.shields.io/github/stars/xpack-dev-tools/realpath-xpack) @@ -141,6 +138,17 @@ feasible. +Similarly to [flatpacks](https://flatpak.org) or [snap](https://snapcraft.io), +but significantly simpler, xPacks include all dependent shared libraries +within the distributed archives, making the binaries independent of +any similar libraries installed on the system. This ensures they +can run on any system without needing specific libraries to be +installed. + +Also the builds are configured so that the binaries do not depend on +being installed in specific folders, and can be installed in any +location, including in user folders. + ## Benefits The main advantages of using the **xPack GNU realpath** are: @@ -151,6 +159,8 @@ procedure; the same procedure is used for all major - multiple versions of the same package can be installed at the same time on the same system - no need to worry about dependent libraries, they are all included +- not affected by system updates that + might change the versions of the dependent libraries - significantly lighter and easier to use than Docker images that provide similar functionality and are GNU/Linux centric - projects can be tied to specific tools versions; this provides a good diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx index d581646..64f09b3 100644 --- a/website/docs/install/index.mdx +++ b/website/docs/install/index.mdx @@ -3,7 +3,7 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to install the xPack GNU realpath +title: Install Guide description: Explain the prerequisites, how to perform an automated or manual installation, how to uninstall, and the folder hierarchies. keywords: - xpack @@ -20,9 +20,6 @@ date: 2020-08-21 11:09:00 +0300 --- -{frontMatter.title} - - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import CodeBlock from '@theme/CodeBlock'; @@ -43,7 +40,7 @@ import Testing from './_testing.mdx'; {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# How to install the xPack GNU realpath [![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack-dev-tools/realpath-xpack)](https://github.com/xpack-dev-tools/realpath-xpack/blob/xpack/package.json) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/xpack-dev-tools/realpath-xpack)](https://github.com/xpack-dev-tools/realpath-xpack/releases/) diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx index 8a8d109..5a5bdef 100644 --- a/website/docs/maintainer/index.mdx +++ b/website/docs/maintainer/index.mdx @@ -3,7 +3,7 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to make new xPack GNU realpath releases +title: Maintainer Information description: Assistance for project maintainers, including the release schedule, versioning scheme, and instructions on how to build, test, and publish. keywords: - xpack @@ -17,9 +17,6 @@ date: 2024-07-21 20:11:00 +0300 --- -{frontMatter.title} - - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -45,7 +42,7 @@ import PlatformDockerBuild from './_common/_platform-docker-build.mdx' {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# How to make new xPack GNU realpath releases [![license](https://img.shields.io/github/license/xpack-dev-tools/realpath-xpack)](https://github.com/xpack-dev-tools/realpath-xpack/blob/xpack/LICENSE) [![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/realpath-xpack.svg)](https://github.com/xpack-dev-tools/realpath-xpack/issues/) diff --git a/website/docs/releases/index.md b/website/docs/releases/index.md index a2bf747..cd627d3 100644 --- a/website/docs/releases/index.md +++ b/website/docs/releases/index.md @@ -3,7 +3,7 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: The xPack GNU realpath releases +title: Releases description: The full list of project releases. keywords: - xpack @@ -16,14 +16,11 @@ date: 2020-07-21 17:53:00 +0300 --- -{frontMatter.title} - - import {ReleasesList} from '@site/src/components/ReleasesList'; {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# The xPack GNU realpath releases The releases, in reverse chronological order are: diff --git a/website/docs/support/index.mdx b/website/docs/support/index.mdx index c3dc87c..9767417 100644 --- a/website/docs/support/index.mdx +++ b/website/docs/support/index.mdx @@ -3,7 +3,7 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to get help for the xPack GNU realpath +title: Help Centre description: The project's support channel, where you can ask questions, start discussions, and report issues. keywords: - xpack @@ -16,14 +16,11 @@ date: 2020-07-21 17:54:00 +0300 --- -{frontMatter.title} - - import Documentation from '../getting-started/_documentation.mdx'; {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# How to get help for the xPack GNU realpath ## Quick links diff --git a/website/docs/test/index.mdx b/website/docs/test/index.mdx index fd294b8..c51d408 100644 --- a/website/docs/test/index.mdx +++ b/website/docs/test/index.mdx @@ -12,9 +12,6 @@ something: "Some text" --- -{frontMatter.title} - - import CodeBlock from '@theme/CodeBlock'; export const world = 'World' @@ -23,7 +20,7 @@ export const xpackSubversion = '1.2' {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# A test page {frontMatter.description} diff --git a/website/docs/user/index.mdx b/website/docs/user/index.mdx index 75358d4..0fe9472 100644 --- a/website/docs/user/index.mdx +++ b/website/docs/user/index.mdx @@ -3,7 +3,7 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to use the xPack GNU realpath +title: User Information description: User information, including the versioning scheme, usage of shared libraries, and RPATH configuration on GNU/Linux. keywords: - xpack @@ -17,9 +17,6 @@ date: 2024-07-21 18:56:00 +0300 --- -{frontMatter.title} - - import customField from '@site/src/libs/customField'; import Versioning from './_versioning.mdx'; @@ -29,7 +26,7 @@ import UseInTesting from './_use-in-testing.mdx'; {/* ------------------------------------------------------------------------ */} -# {frontMatter.title} +# How to use the xPack GNU realpath This page is intended for those who plan to use the **xPack GNU realpath** binaries in their workflows. diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index d155a51..723df2d 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -15,6 +15,10 @@ import {fileURLToPath} from 'node:url'; import path from 'node:path'; import fs from 'node:fs'; + + +// ---------------------------------------------------------------------------- + function getCustomFields() { const pwd = fileURLToPath(import.meta.url); // logger.info(pwd); @@ -76,9 +80,15 @@ function getCustomFields() { } } +// ---------------------------------------------------------------------------- + const customFields = getCustomFields(); logger.info(customFields); + + +// ---------------------------------------------------------------------------- + const config: Config = { title: 'xPack GNU realpath', tagline: 'A binary distribution of GNU realpath', @@ -289,8 +299,9 @@ const config: Config = { } ], navbar: { - // overriden by i18n/en/docusaurus-theme-classic. + // Overriden by i18n/en/docusaurus-theme-classic. title: 'The xPack Binary Development Tools', + logo: { alt: 'xPack Logo', src: 'img/components-256.png', diff --git a/website/src/components/HomepageTools/index.tsx b/website/src/components/HomepageTools/index.tsx deleted file mode 100644 index 84f4fe3..0000000 --- a/website/src/components/HomepageTools/index.tsx +++ /dev/null @@ -1,201 +0,0 @@ -/* - * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. - * - * 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 clsx from 'clsx'; -import Heading from '@theme/Heading'; -import styles from './styles.module.css'; - -import Link from '@docusaurus/Link'; - -/* When updated, don't forget to add sitemap to robots.txt! */ -const PrimaryTools = [ - { - appName: 'GNU AArch64 Embedded GCC', - appLcName: 'aarch64-none-elf-gcc' - }, - { - appName: 'GNU Arm Embedded GCC', - appLcName: 'arm-none-eabi-gcc' - }, - { - appName: 'LLVM clang', - appLcName: 'clang' - }, - { - appName: 'CMake', - appLcName: 'cmake' - }, - { - appName: 'GCC', - appLcName: 'gcc' - }, - { - appName: 'Meson Build', - appLcName: 'meson-build' - }, - { - appName: 'MinGW-w64 GCC', - appLcName: 'mingw-w64-gcc' - }, - { - appName: 'Ninja Build', - appLcName: 'ninja-build' - }, - { - appName: 'OpenOCD', - appLcName: 'openocd' - }, - { - appName: 'QEMU Arm', - appLcName: 'qemu-arm' - }, - { - appName: 'QEMU RISC-V', - appLcName: 'qemu-riscv' - }, - { - appName: 'GNU RISC-V Embedded GCC', - appLcName: 'riscv-none-elf-gcc' - }, - { - appName: 'Windows Build Tools', - appLcName: 'windows-build-tools' - }, -] - -/* When updated, don't forget to add sitemap to robots.txt! */ -const SecondaryTools = [ - { - appName: 'GNU bison', - appLcName: 'bison' - }, - { - appName: 'flex', - appLcName: 'flex' - }, - { - appName: 'GNU m4', - appLcName: 'm4' - }, - { - appName: 'NixOS PatchELF', - appLcName: 'patchelf' - }, - { - appName: 'pkg-config', - appLcName: 'pkg-config' - }, - { - appName: 'GNU realpath', - appLcName: 'realpath' - }, - { - appName: 'GNU sed', - appLcName: 'sed' - }, - { - appName: 'WineHQ', - appLcName: 'wine' - }, -] - -const WorkInProgressTools = [ - { - appName: 'GNU Bash', - appLcName: 'bash' - }, - { - appName: 'GNU texinfo', - appLcName: 'texinfo' - }, -] - -function Tool({ appName, appLcName }) { - return ( - <> -
-
- {appLcName} - xPack {appName} -
-
- GitHub Release -  GitHub Release Date -  GitHub Downloads (all assets, all releases) -  GitHub Repo stars -
-
- - ) -} - -function ToolWork({ appName, appLcName }) { - return ( - <> -
- {appLcName} - xPack {appName} -
- - ) -} - -function ToolsLeft() { - return ( -
-
- Main Tools - {PrimaryTools.map((props, idx) => ( - - ))} -
-
- ); -} - -function ToolsRight() { - return ( -
-
- Supplementary Tools - {SecondaryTools.map((props, idx) => ( - - ))} -
-
-
- Work in Progress - {WorkInProgressTools.map((props, idx) => ( - - ))} -
-
-
- Internal - xbb-helper - xPack Build Helper -
-
- ); -} - -export default function HomepageTools(): JSX.Element { - return ( -
-
-
- - -
-
-
- ); -} diff --git a/website/src/components/HomepageTools/styles.module.css b/website/src/components/HomepageTools/styles.module.css deleted file mode 100644 index 483d28c..0000000 --- a/website/src/components/HomepageTools/styles.module.css +++ /dev/null @@ -1,16 +0,0 @@ -/* - * DO NOT EDIT! - * Automatically generated from xbb-helper/templates/docusaurus/common. - */ - -.features { - display: flex; - align-items: center; - padding: 0rem 0 0rem 0; - width: 100%; -} - -.featureSvg { - height: 100px; - width: 100px; -} diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index c1256d7..e1cb813 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -42,7 +42,7 @@ export default function Home(): JSX.Element { const {siteConfig} = useDocusaurusContext(); return (