Skip to content

Commit

Permalink
website: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Oct 10, 2024
1 parent 3204e92 commit 2f373ee
Show file tree
Hide file tree
Showing 18 changed files with 217 additions and 103 deletions.
12 changes: 11 additions & 1 deletion website/docs/about/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
11 changes: 10 additions & 1 deletion website/docs/developer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions website/docs/faq/_more.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

{/* ------------------------------------------------------------------------ */}
14 changes: 0 additions & 14 deletions website/docs/faq/index.md

This file was deleted.

29 changes: 29 additions & 0 deletions website/docs/faq/index.mdx
Original file line number Diff line number Diff line change
@@ -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

<More />

<NixOs />

<FlatpackSnap />
16 changes: 14 additions & 2 deletions website/docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)

Expand Down Expand Up @@ -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.

<Link to="https://www.macstadium.com/"><img className="mac-stadium-img" src="https://uploads-ssl.webflow.com/5ac3c046c82724970fc60918/5c019d917bba312af7553b49_MacStadium-developerlogo.png"></img></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

Expand Down
72 changes: 0 additions & 72 deletions website/docs/install/_folder-hierarchies.mdx

This file was deleted.

18 changes: 18 additions & 0 deletions website/docs/install/_folders-hierarchies-linux.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

import CodeBlock from '@theme/CodeBlock';

import customField from '@site/src/libs/customField';

{/* ------------------------------------------------------------------------ */}

<CodeBlock language="console"> {
`$ 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
`} </CodeBlock>
22 changes: 22 additions & 0 deletions website/docs/install/_folders-hierarchies-macos.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

import CodeBlock from '@theme/CodeBlock';

import customField from '@site/src/libs/customField';

{/* ------------------------------------------------------------------------ */}

<CodeBlock language="console"> {
`$ 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
`} </CodeBlock>
20 changes: 20 additions & 0 deletions website/docs/install/_folders-hierarchies-windows.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

import CodeBlock from '@theme/CodeBlock';

import customField from '@site/src/libs/customField';

{/* ------------------------------------------------------------------------ */}

<CodeBlock language="console"> {
`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
`} </CodeBlock>
46 changes: 43 additions & 3 deletions website/docs/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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/)
Expand Down Expand Up @@ -639,7 +654,32 @@ and `.content` to store the unpacked archive.

<ManualInstallQuickTest/>

<FolderHierarchies/>
## Folders hierarchy

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="windows" label="Windows" default>

<FoldersHierarchiesWindows />

</TabItem>

<TabItem value="macos" label="macOS">

<FoldersHierarchiesMacOS />

</TabItem>

<TabItem value="linux" label="GNU/Linux">

<FoldersHierarchiesLinux />

</TabItem>

</Tabs>

<Miscellaneous/>

Expand Down
12 changes: 11 additions & 1 deletion website/docs/maintainer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand Down
9 changes: 8 additions & 1 deletion website/docs/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -15,6 +20,8 @@ import {ReleasesList} from '@site/src/components/ReleasesList';

{/* ------------------------------------------------------------------------ */}

# The xPack Ninja Build releases

The releases, in reverse chronological order are:

<ReleasesList />
Loading

0 comments on commit 2f373ee

Please sign in to comment.