diff --git a/website/docs/about/index.mdx b/website/docs/about/index.mdx index ecd3905..a7cd456 100644 --- a/website/docs/about/index.mdx +++ b/website/docs/about/index.mdx @@ -3,7 +3,15 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: About the xPack Ninja Build +title: About ninja-build +description: Details about the project, including its history, the history of the website, and details about the author. +keywords: + - xpack + - ninja-build + - about + - history + - web + - author date: 2024-09-22 10:23:00 +0300 @@ -16,6 +24,8 @@ import Website from './_website.mdx' {/* ------------------------------------------------------------------------ */} +# About the xPack Ninja Build + ## The project The **xPack Ninja Build** project is part of the diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx index da4f45c..203fbbb 100644 --- a/website/docs/developer/index.mdx +++ b/website/docs/developer/index.mdx @@ -3,7 +3,14 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to build the xPack Ninja Build +title: How to build ninja-build +description: Assistance for developers looking to build the packages, including prerequisites, repositories used, and actions for each supported platform. +keywords: + - xpack + - ninja-build + - prerequisites + - repositories + - build date: 2024-07-21 20:33:00 +0300 @@ -22,6 +29,8 @@ import More from './_more.mdx' {/* ------------------------------------------------------------------------ */} +# How to build the xPack Ninja Build + [![license](https://img.shields.io/github/license/xpack-dev-tools/ninja-build-xpack)](https://github.com/xpack-dev-tools/ninja-build-xpack/blob/xpack/LICENSE) This page is intended for those who want to build the diff --git a/website/docs/faq/_more.mdx b/website/docs/faq/_more.mdx new file mode 100644 index 0000000..2a39939 --- /dev/null +++ b/website/docs/faq/_more.mdx @@ -0,0 +1,2 @@ + +{/* ------------------------------------------------------------------------ */} diff --git a/website/docs/faq/index.md b/website/docs/faq/index.md deleted file mode 100644 index f54b9a7..0000000 --- a/website/docs/faq/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: The xPack Ninja Build Frequently Asked Questions - -hide_table_of_contents: true - -date: 2020-09-28 17:49:00 +0300 - ---- - -
-Warum? - -Darum. -
diff --git a/website/docs/faq/index.mdx b/website/docs/faq/index.mdx new file mode 100644 index 0000000..59817c7 --- /dev/null +++ b/website/docs/faq/index.mdx @@ -0,0 +1,29 @@ +--- +title: Frequently Asked Questions about ninja-build +description: Answers to previously asked questions, so you can find solutions without having to ask again. +keywords: + - xpack + - ninja-build + - frequently + - asked + - questions + +hide_table_of_contents: true + +date: 2020-07-21 17:49:00 +0300 + +--- + +import More from './_more.mdx' +import NixOs from './_common/_nixos.mdx' +import FlatpackSnap from './_common/_flatpack-snap.mdx' + +{/* ------------------------------------------------------------------------ */} + +# The xPack Ninja Build Frequently Asked Questions + + + + + + diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx index 107c8d6..dbc9dc4 100644 --- a/website/docs/getting-started/index.mdx +++ b/website/docs/getting-started/index.mdx @@ -3,7 +3,17 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: Getting Started with xPack Ninja Build +title: Getting Started with ninja-build +description: The initial steps to explore the project, including what xpacks are, the project's features, benefits, compatibility, and available documentation. +keywords: + - xpack + - ninja-build + - overview + - xpacks + - features + - benefits + - compatibility + - documentation date: 2020-07-21 17:49:00 +0300 @@ -20,6 +30,8 @@ import ReleaseSchedule from './_release-schedule.mdx' {/* ------------------------------------------------------------------------ */} +# Getting Started with xPack Ninja Build + [![license](https://img.shields.io/github/license/xpack-dev-tools/ninja-build-xpack)](https://github.com/xpack-dev-tools/ninja-build-xpack/blob/xpack/LICENSE) ![GitHub Repo stars](https://img.shields.io/github/stars/xpack-dev-tools/ninja-build-xpack) @@ -202,7 +214,7 @@ corresponding licenses are available in each archive in the The list of releases is available in the [Releases](/docs/releases/) pages. - +MacStadium ## Credits diff --git a/website/docs/install/_folder-hierarchies.mdx b/website/docs/install/_folder-hierarchies.mdx deleted file mode 100644 index 0d7c4bb..0000000 --- a/website/docs/install/_folder-hierarchies.mdx +++ /dev/null @@ -1,72 +0,0 @@ - -import CodeBlock from '@theme/CodeBlock'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -import customField from '@site/src/libs/customField'; - -{/* ------------------------------------------------------------------------ */} - -## Folder hierarchy - -After install, the package creates a folder hierarchy like the following -(only the first two depth levels are shown): - - - - - - { -`C:\> tree /f %USERPROFILE%\\AppData\\Roaming\\xPacks\\@xpack-dev-tools\\ninja-build\\${customField('xpackVersion')}\\.content -Folder PATH listing -Volume serial number is B02D-925C -├── README.md -├── bin -│ ├── libwinpthread-1.dll -│ └── ninja.exe -└── distro-info - └── licenses - -3 directories, 3 files -`} - - - - - - { -`$ tree -L 2 ~/Library/xPacks/\@xpack-dev-tools/ninja-build/${customField('xpackVersion')}/.content/ -/Users/ilg/Library/xPacks/\@xpack-dev-tools/ninja-build/${customField('xpackVersion')}/.content/ -├── README.md -├── bin -│ └── ninja -├── distro-info -│ └── licenses -└── libexec - ├── libc++.1.0.dylib - ├── libc++abi.1.0.dylib - └── libunwind.1.0.dylib - -5 directories, 5 files -`} - - - - - - { -`$ tree -L 2 ~/.local/xPacks/\@xpack-dev-tools/ninja-build/${customField('xpackVersion')}/.content/ -/home/ilg/.local/xPacks/\@xpack-dev-tools/ninja-build/${customField('xpackVersion')}/.content/ -├── README.md -├── bin -│ └── ninja -└── distro-info - └── licenses - -3 directories, 2 files -`} - - - - - diff --git a/website/docs/install/_folders-hierarchies-linux.mdx b/website/docs/install/_folders-hierarchies-linux.mdx new file mode 100644 index 0000000..4f1ec69 --- /dev/null +++ b/website/docs/install/_folders-hierarchies-linux.mdx @@ -0,0 +1,18 @@ + +import CodeBlock from '@theme/CodeBlock'; + +import customField from '@site/src/libs/customField'; + +{/* ------------------------------------------------------------------------ */} + + { +`$ tree -L 2 ~/.local/xPacks/\@xpack-dev-tools/ninja-build/${customField('xpackVersion')}/.content/ +/home/ilg/.local/xPacks/\@xpack-dev-tools/ninja-build/${customField('xpackVersion')}/.content/ +├── README.md +├── bin +│ └── ninja +└── distro-info + └── licenses + +3 directories, 2 files +`} diff --git a/website/docs/install/_folders-hierarchies-macos.mdx b/website/docs/install/_folders-hierarchies-macos.mdx new file mode 100644 index 0000000..5bf367b --- /dev/null +++ b/website/docs/install/_folders-hierarchies-macos.mdx @@ -0,0 +1,22 @@ + +import CodeBlock from '@theme/CodeBlock'; + +import customField from '@site/src/libs/customField'; + +{/* ------------------------------------------------------------------------ */} + + { +`$ tree -L 2 ~/Library/xPacks/\@xpack-dev-tools/ninja-build/${customField('xpackVersion')}/.content/ +/Users/ilg/Library/xPacks/\@xpack-dev-tools/ninja-build/${customField('xpackVersion')}/.content/ +├── README.md +├── bin +│ └── ninja +├── distro-info +│ └── licenses +└── libexec + ├── libc++.1.0.dylib + ├── libc++abi.1.0.dylib + └── libunwind.1.0.dylib + +5 directories, 5 files +`} diff --git a/website/docs/install/_folders-hierarchies-windows.mdx b/website/docs/install/_folders-hierarchies-windows.mdx new file mode 100644 index 0000000..3b47a28 --- /dev/null +++ b/website/docs/install/_folders-hierarchies-windows.mdx @@ -0,0 +1,20 @@ + +import CodeBlock from '@theme/CodeBlock'; + +import customField from '@site/src/libs/customField'; + +{/* ------------------------------------------------------------------------ */} + + { +`C:\> tree /f %USERPROFILE%\\AppData\\Roaming\\xPacks\\@xpack-dev-tools\\ninja-build\\${customField('xpackVersion')}\\.content +Folder PATH listing +Volume serial number is B02D-925C +├── README.md +├── bin +│ ├── libwinpthread-1.dll +│ └── ninja.exe +└── distro-info + └── licenses + +3 directories, 3 files +`} diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx index c1e0e08..d42031d 100644 --- a/website/docs/install/index.mdx +++ b/website/docs/install/index.mdx @@ -3,7 +3,16 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to install the xPack Ninja Build binaries +title: How to install ninja-build +description: Explain the prerequisites, how to perform an automated or manual installation, how to uninstall, and the folder hierarchies. +keywords: + - xpack + - ninja-build + - prerequisites + - automated + - install + - uninstall + - files hide_table_of_contents: false @@ -21,12 +30,18 @@ import LinksVsForwarders from '@site/src/components/LinksVsForwarders' import AutomaticInstallQuickTest from './_automatic-install-quick-test.mdx' import ManualInstallQuickTest from './_manual-install-quick-test.mdx' -import FolderHierarchies from './_folder-hierarchies.mdx' + +import FoldersHierarchiesLinux from './_folders-hierarchies-linux.mdx' +import FoldersHierarchiesWindows from './_folders-hierarchies-windows.mdx' +import FoldersHierarchiesMacOS from './_folders-hierarchies-macos.mdx' + import Miscellaneous from './_miscellaneous.mdx' import Testing from './_testing.mdx'; {/* ------------------------------------------------------------------------ */} +# How to install xPack Ninja Build + [![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack-dev-tools/ninja-build-xpack)](https://github.com/xpack-dev-tools/ninja-build-xpack/blob/xpack/package.json) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/xpack-dev-tools/ninja-build-xpack)](https://github.com/xpack-dev-tools/ninja-build-xpack/releases/) [![GitHub Release Date](https://img.shields.io/github/release-date/xpack-dev-tools/ninja-build-xpack)](https://github.com/xpack-dev-tools/ninja-build-xpack/releases/) @@ -639,7 +654,32 @@ and `.content` to store the unpacked archive. - +## Folders hierarchy + +After install, the package creates a hierarchy of folders like the following +(only the first two depth levels are shown): + + + + + + + + + + + + + + + + + + + + + + diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx index e7b3a08..2fa8ff4 100644 --- a/website/docs/maintainer/index.mdx +++ b/website/docs/maintainer/index.mdx @@ -3,7 +3,15 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to make new xPack Ninja Build releases +title: How to release ninja-build +description: Assistance for project maintainers, including the release schedule, versioning scheme, and instructions on how to build, test, and publish. +keywords: + - xpack + - ninja-build + - releases + - build + - publish + - npmjs date: 2024-07-21 20:11:00 +0300 @@ -34,6 +42,8 @@ import PlatformDockerBuild from './_common/_platform-docker-build.mdx' {/* ------------------------------------------------------------------------ */} +# How to make new xPack Ninja Build releases + [![license](https://img.shields.io/github/license/xpack-dev-tools/ninja-build-xpack)](https://github.com/xpack-dev-tools/ninja-build-xpack/blob/xpack/LICENSE) [![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/ninja-build-xpack.svg)](https://github.com/xpack-dev-tools/ninja-build-xpack/issues/) [![GitHub pulls](https://img.shields.io/github/issues-pr/xpack-dev-tools/ninja-build-xpack.svg)](https://github.com/xpack-dev-tools/ninja-build-xpack/pulls) diff --git a/website/docs/releases/index.md b/website/docs/releases/index.md index 00d2d22..2e79f4e 100644 --- a/website/docs/releases/index.md +++ b/website/docs/releases/index.md @@ -3,7 +3,12 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: The xPack Ninja Build releases +title: Releases of ninja-build +description: The full list of project releases. +keywords: + - xpack + - ninja-build + - releases hide_table_of_contents: true @@ -15,6 +20,8 @@ import {ReleasesList} from '@site/src/components/ReleasesList'; {/* ------------------------------------------------------------------------ */} +# The xPack Ninja Build releases + The releases, in reverse chronological order are: diff --git a/website/docs/support/index.mdx b/website/docs/support/index.mdx index 6bbaae3..614b355 100644 --- a/website/docs/support/index.mdx +++ b/website/docs/support/index.mdx @@ -3,7 +3,14 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to get help for xPack Ninja Build +title: How to get help for ninja-build +description: The project's support channel, where you can ask questions, start discussions, and report issues. +keywords: + - xpack + - ninja-build + - support + - discussions + - issues date: 2020-07-21 17:54:00 +0300 @@ -13,6 +20,8 @@ import Documentation from '../getting-started/_documentation.mdx'; {/* ------------------------------------------------------------------------ */} +# How to get help for xPack Ninja Build + ## Quick links The quick answer is to use the diff --git a/website/docs/test/index.mdx b/website/docs/test/index.mdx index 1e08ec8..c51d408 100644 --- a/website/docs/test/index.mdx +++ b/website/docs/test/index.mdx @@ -4,7 +4,7 @@ # Automatically generated from xbb-helper/templates/docusaurus/common. title: A test page -description: A short description +description: Some markdown examples. something: "Some text" @@ -20,6 +20,8 @@ export const xpackSubversion = '1.2' {/* ------------------------------------------------------------------------ */} +# A test page + {frontMatter.description} {frontMatter.something} @@ -28,7 +30,7 @@ export const xpackSubversion = '1.2' Hello {world}! -# Hello {world}! +## Hello {world}! - Hello {world}! diff --git a/website/docs/user/index.mdx b/website/docs/user/index.mdx index f472e4e..620f03f 100644 --- a/website/docs/user/index.mdx +++ b/website/docs/user/index.mdx @@ -3,7 +3,15 @@ # DO NOT EDIT! # Automatically generated from xbb-helper/templates/docusaurus/common. -title: How to use the xPack Ninja Build +title: How to use ninja-build +description: User information, including the versioning scheme, usage of shared libraries, and RPATH configuration on GNU/Linux. +keywords: + - xpack + - ninja-build + - user + - versioning + - shared + - rpath date: 2024-07-21 18:56:00 +0300 @@ -18,6 +26,8 @@ import UseInTesting from './_use-in-testing.mdx'; {/* ------------------------------------------------------------------------ */} +# How to use the xPack Ninja Build + This page is intended for those who plan to use the **xPack Ninja Build** binaries in their workflows. diff --git a/website/src/components/HomepageTools/index.tsx b/website/src/components/HomepageTools/index.tsx index 5507389..7ad2837 100644 --- a/website/src/components/HomepageTools/index.tsx +++ b/website/src/components/HomepageTools/index.tsx @@ -129,7 +129,7 @@ function Tool({ appName, appLcName }) { {appLcName} - xPack {appName}
- + GitHub Release  GitHub Release Date  GitHub Downloads (all assets, all releases)
diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index 8508f82..b7d021f 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -41,9 +41,9 @@ function HomepageHeader() { export default function Home(): JSX.Element { const {siteConfig} = useDocusaurusContext(); return ( - +