`](mailto:ilg@livius.net).
Please note, this email address is provided as a courtesy.
For all correspondence related to the
diff --git a/website/docs/about/_common/History32bitDiscontinued/index.tsx b/website/docs/project/history/_common/History32bitDiscontinued/index.tsx
similarity index 100%
rename from website/docs/about/_common/History32bitDiscontinued/index.tsx
rename to website/docs/project/history/_common/History32bitDiscontinued/index.tsx
diff --git a/website/docs/about/_common/HistoryAppleSiliconAdded/index.tsx b/website/docs/project/history/_common/HistoryAppleSiliconAdded/index.tsx
similarity index 100%
rename from website/docs/about/_common/HistoryAppleSiliconAdded/index.tsx
rename to website/docs/project/history/_common/HistoryAppleSiliconAdded/index.tsx
diff --git a/website/docs/about/_common/HistoryArmLinuxAdded/index.tsx b/website/docs/project/history/_common/HistoryArmLinuxAdded/index.tsx
similarity index 100%
rename from website/docs/about/_common/HistoryArmLinuxAdded/index.tsx
rename to website/docs/project/history/_common/HistoryArmLinuxAdded/index.tsx
diff --git a/website/docs/about/_common/HistoryPlatformsAdded/index.tsx b/website/docs/project/history/_common/HistoryPlatformsAdded/index.tsx
similarity index 100%
rename from website/docs/about/_common/HistoryPlatformsAdded/index.tsx
rename to website/docs/project/history/_common/HistoryPlatformsAdded/index.tsx
diff --git a/website/docs/about/_common/HistoryRenameXpack/index.tsx b/website/docs/project/history/_common/HistoryRenameXpack/index.tsx
similarity index 100%
rename from website/docs/about/_common/HistoryRenameXpack/index.tsx
rename to website/docs/project/history/_common/HistoryRenameXpack/index.tsx
diff --git a/website/docs/about/_common/HistoryWindowsUcrt/index.tsx b/website/docs/project/history/_common/HistoryWindowsUcrt/index.tsx
similarity index 100%
rename from website/docs/about/_common/HistoryWindowsUcrt/index.tsx
rename to website/docs/project/history/_common/HistoryWindowsUcrt/index.tsx
diff --git a/website/docs/project/history/_common/HistoryXpm/index.tsx b/website/docs/project/history/_common/HistoryXpm/index.tsx
new file mode 100644
index 0000000..f0bf5db
--- /dev/null
+++ b/website/docs/project/history/_common/HistoryXpm/index.tsx
@@ -0,0 +1,21 @@
+/*
+ * DO NOT EDIT!
+ * 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.
+ *
+ * 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 customField from '@site/src/libs/customField';
+
+export default function HistoryXpm({specifier}): JSX.Element {
+ return (
+ <>The xPack metadata has been added, and the package can now be more conveniently installed via xpm. It is available from npmjs.com as {specifier ? specifier : 'xpack-dev-tools.github.io'}
+ );
+}
diff --git a/website/docs/about/_common/HistoryZipAdded/index.tsx b/website/docs/project/history/_common/HistoryZipAdded/index.tsx
similarity index 100%
rename from website/docs/about/_common/HistoryZipAdded/index.tsx
rename to website/docs/project/history/_common/HistoryZipAdded/index.tsx
diff --git a/website/docs/about/_common/_history-gnu-arm-eclipse.mdx b/website/docs/project/history/_common/_history-gnu-arm-eclipse.mdx
similarity index 100%
rename from website/docs/about/_common/_history-gnu-arm-eclipse.mdx
rename to website/docs/project/history/_common/_history-gnu-arm-eclipse.mdx
diff --git a/website/docs/about/_common/_history-rename-xpack.mdx b/website/docs/project/history/_common/_history-rename-xpack.mdx
similarity index 100%
rename from website/docs/about/_common/_history-rename-xpack.mdx
rename to website/docs/project/history/_common/_history-rename-xpack.mdx
diff --git a/website/docs/about/_common/_history-restructuring.mdx b/website/docs/project/history/_common/_history-restructuring.mdx
similarity index 100%
rename from website/docs/about/_common/_history-restructuring.mdx
rename to website/docs/project/history/_common/_history-restructuring.mdx
diff --git a/website/docs/about/_common/_history-setup-discontinued.mdx b/website/docs/project/history/_common/_history-setup-discontinued.mdx
similarity index 100%
rename from website/docs/about/_common/_history-setup-discontinued.mdx
rename to website/docs/project/history/_common/_history-setup-discontinued.mdx
diff --git a/website/docs/about/_common/_history-xbb-v5.mdx b/website/docs/project/history/_common/_history-xbb-v5.mdx
similarity index 100%
rename from website/docs/about/_common/_history-xbb-v5.mdx
rename to website/docs/project/history/_common/_history-xbb-v5.mdx
diff --git a/website/docs/about/_history.mdx b/website/docs/project/history/_history.mdx
similarity index 93%
rename from website/docs/about/_history.mdx
rename to website/docs/project/history/_history.mdx
index 472281d..cd2e545 100644
--- a/website/docs/about/_history.mdx
+++ b/website/docs/project/history/_history.mdx
@@ -4,5 +4,5 @@
The project was created in **DATE**.
The first **xPack Binary Development Tools** release was
-[v...](URL),
+...,
in **DATE**.
diff --git a/website/docs/project/history/index.mdx b/website/docs/project/history/index.mdx
new file mode 100644
index 0000000..f806a10
--- /dev/null
+++ b/website/docs/project/history/index.mdx
@@ -0,0 +1,20 @@
+---
+
+title: History
+description: The most important moments since the project was created.
+keywords:
+ - xpack
+ - xpack-dev-tools.github.io
+ - history
+
+date: 2024-10-24 23:58:00 +0300
+
+---
+
+import History from './_history.mdx'
+
+{/* ------------------------------------------------------------------------ */}
+
+# The xPack Binary Development Tools history
+
+
diff --git a/website/docs/support/index.mdx b/website/docs/support/index.mdx
new file mode 100644
index 0000000..e92f7fd
--- /dev/null
+++ b/website/docs/support/index.mdx
@@ -0,0 +1,131 @@
+---
+
+# DO NOT EDIT!
+# Automatically generated from docusaurus-template-liquid/templates/docusaurus.
+
+title: Help Centre
+description: The project's support channel, where you can ask questions, start discussions, and report issues.
+keywords:
+ - xpack
+ - xpack-dev-tools.github.io
+ - support
+ - discussions
+ - issues
+
+date: 2020-07-21 17:54:00 +0300
+
+---
+
+import Documentation from '../getting-started/_documentation.mdx';
+
+{/* ------------------------------------------------------------------------ */}
+
+# How to get help for the xPack Binary Development Tools
+
+
+## Quick tips
+
+The **Binary Development Tools** consists of multiple individual
+projects, each hosted on its own GitHub repository. Therefore, the best
+way to get answers quickly is to use the
+GitHub Discussions
+pages for the specific project you're interested in.
+
+
+## Web pages issues
+
+If you find any issues in the content of these pages (such as typos or
+incorrect phrasing) or have suggestions for improving the documentation,
+please share them through the
+GitHub Discussions pages. Use the top-level
+[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)
+page for issues related to the main xPack Project site, or the individual project’s GitHub Discussions pages for specific projects.
+
+## Check documentation
+
+As usual, before asking anything, it is a good idea to check the project
+documentation.
+
+
+
+## Preliminary checks
+
+Before posting any questions or providing feedback,
+check if the subject was not already addressed.
+
+- check the FAQ
+for similar problems
+- check the GitHub Discussions for
+similar topics
+- check the
+GitHub Issues
+tracker and the
+GitHub Pull Requests
+for similar problems.
+
+## Ask questions in GitHub Discussions
+
+If you still could not find a solution, if you have interesting use
+cases, if you have custom configurations, and generally if you have
+any experience that you want to share with others,
+use the top-level
+[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)
+page for questions related to the top xPack Project. For specific projects,
+use the individual project's GitHub Discussions pages.
+Enter a **New discussion**; use the **Q&A** category for questions,
+**Ideas** for suggestions and **General** for everything else.
+
+
+
+## Stack Overflow
+
+For community help, you can also use
+[Stack Overflow](https://stackoverflow.com/).
+Tag your questions with `xpack`.
+
+:::tip
+
+Please be aware that there is another tag `elastic-x-pack` for a different
+project, and some of their questions are tagged with `xpack` too.
+
+:::
+
+## The Discord channel
+
+For live discussions among members, join the **xPack Community** on
+[Discord](https://discord.com/invite/kbzWaJerFG).
+
+Currently, there are three channels available:
+
+- `#xpm`
+- `#xcdl`
+- `#xpack-dev-tools`
+- `#general`
+
+These channels are open for free discussions on their respective topics.
+
+However, for support, please use GitHub Discussions whenever possible.
+
+## X/Twitter
+
+New releases and other announcements are posted on
+[X/Twitter](https://twitter.com/xpack_project).
+
+Follow the hashtag `#xpack_project` for the latest updates.
+
+## Use of private e-mail
+
+:::caution Please, please, please!
+
+**Do not** use
+private e-mail for support, **use the
+[GitHub Discussions](https://github.com/xpack-dev-tools/xpack-dev-tools.github.io/discussions)** pages.
+
+:::
+
+Sending private messages will be automatically replied with
+a short message including a link to this page.
+The reason for this rude behaviour is simply an attempt to use
+the time more efficiently; since discussions are archived, other people
+having similar problems might benefit from the answers.
+
diff --git a/website/docs/test/index.mdx b/website/docs/test/index.mdx
new file mode 100644
index 0000000..837975d
--- /dev/null
+++ b/website/docs/test/index.mdx
@@ -0,0 +1,209 @@
+---
+
+# DO NOT EDIT!
+# Automatically generated from docusaurus-template-liquid/templates/docusaurus.
+
+title: A test page
+description: Some markdown examples.
+
+unlisted: true
+
+something: "Some text"
+
+# https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter
+
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import Heading from '@theme/Heading';
+
+import CodeBlock from '@theme/CodeBlock';
+
+export const world = 'World'
+export const version = '11.2.1'
+export const xpackSubversion = '1.2'
+
+{/* ------------------------------------------------------------------------ */}
+
+# A test page
+
+{frontMatter.description}
+
+{frontMatter.something}
+
+abc {frontMatter.something} cde
+
+Hello {world}!
+
+## Hello {world}!
+
+- Hello {world}!
+
+ One
+ Hello {world}!
+ Two
+
+Five `Hello {world}!` Four
+
+Six Hello {world}! Four
+
+Seven Hello {world}! Four
+
+```bash
+Five
+Hello {world}!
+Six
+```
+
+
+Seven
+Hello {world}!
+Eight
+
+
+---
+
+## Admonitions
+
+:::note
+
+Some white **content** with _Markdown_ `syntax`. Check [this `api`](#).
+
+:::
+
+:::note Custom text
+
+Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
+
+:::
+
+:::info
+
+Some blue **content** with _Markdown_ `syntax`. Check [this `api`](#).
+
+:::
+
+:::tip
+
+Some green **content** with _Markdown_ `syntax`. Check [this `api`](#).
+
+:::
+
+:::caution
+
+Some orange **content** with _Markdown_ `syntax`. Check [this `api`](#).
+
+:::
+
+:::danger
+
+Some red **content** with _Markdown_ `syntax`. Check [this `api`](#).
+
+:::
+
+Jekyll `{% include note.html` must be replaced by `:::info`.
+
+---
+
+## Expandable details
+
+
+ How are remark-math and rehype-katex different?
+
+In case you are wondering how Remark and Rehype are different, here is a good example. `remark-math` operates on the Markdown AST, where it sees text like `$...$`, and all it does is transform that to the JSX `...` without doing too much with the content. This decouples the extraction of math formulae from their rendering, which means you can swap $\KaTeX$ out with other math renderers, like MathJax (with [`rehype-mathjax`](https://github.com/remarkjs/remark-math/tree/main/packages/rehype-mathjax)), just by replacing the Rehype plugin.
+
+Next, the `rehype-katex` operates on the Hypertext AST where everything has been converted to HTML-like tags already. It traverses all the elements with `math` class and uses $\KaTeX$ to parse and render the content to actual HTML.
+
+
+
+---
+
+## Section name with custom url {#custom}
+
+By default the url concatenates the words joined by dash.
+
+---
+
+## Code with file name
+
+```js title="src/remark/section-prefix.js"
+const visit = require('unist-util-visit');
+```
+
+---
+
+## Syntax highlighting
+
+- https://docusaurus.io/docs/markdown-features/code-blocks#syntax-highlighting
+- https://github.com/FormidableLabs/prism-react-renderer
+- https://github.com/FormidableLabs/prism-react-renderer/blob/master/packages/generate-prism-languages/index.ts
+
+---
+
+{
+`$ tree -L 2 /home/ilg/.local/xPacks/arm-none-eabi-gcc/xpack-arm-none-eabi-gcc-${version}-${xpackSubversion}
+/home/ilg/.local/xPacks/arm-none-eabi-gcc/xpack-arm-none-eabi-gcc-${version}-${xpackSubversion}
+├── arm-none-eabi
+│ ├── bin
+│ ├── include
+│ ├── lib
+│ └── share
+├── README.md
+└── share
+ ├── doc
+ └── gcc-arm-none-eabi
+
+21 directories, 62 files
+`}
+
+---
+
+## Tabs
+
+
+
+
+
+...
+
+
+
+
+
+...
+
+
+
+
+
+...
+
+
+
+
+
+## Headers in tabs
+
+To display headings not showing in the TOC:
+
+My Heading
+
+## Conditional markdown
+
+```
+### Edit the {props.doReconstruct === "true" ? (`LICENSE-XPACK`) : (`LICENSE`)} file
+```
+
+or
+
+```
+
+- select the `master` branch
+- create a new `xpack` branch
+- switch to it
+{props.doReconstruct === "true" ? (- rename
LICENSE to LICENSE-XPACK. ) : (<>)}
+{props.doReconstruct === "true" ? (- rename
README.md to README-XPACK.md. ) : (<>)}
+- Push the `xpack` branch
+
+```
diff --git a/website/docusaurus-config-redirects.ts b/website/docusaurus-config-redirects.ts
index dde44fe..05be41d 100644
--- a/website/docusaurus-config-redirects.ts
+++ b/website/docusaurus-config-redirects.ts
@@ -25,7 +25,10 @@ export const redirects = {
// to: '/docs/newDoc2',
// from: ['/docs/oldDocFrom2019', '/docs/legacyDocFrom2016'],
// },
-
+ {
+ from: '/docs/about',
+ to: '/docs/project/about',
+ },
],
createRedirects(existingPath) {
console.log(existingPath);
@@ -44,6 +47,5 @@ export const redirects = {
// }
// return undefined; // Return a falsy value: no redirect created
// },
-
-}
+ }
}
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
index 9056fa5..91642e2 100644
--- a/website/docusaurus.config.ts
+++ b/website/docusaurus.config.ts
@@ -188,7 +188,6 @@ const config: Config = {
logo: {
alt: 'xPack Logo',
src: 'img/components-256.png',
- // href: 'https://xpack.github.io/',
href: 'https://xpack-dev-tools.github.io/'
},
items: [
@@ -199,21 +198,44 @@ const config: Config = {
position: 'left'
},
{
+ type: 'dropdown',
label: 'Documentation',
to: 'docs/getting-started',
position: 'left',
+ items: [
+ {
+ label: 'Getting Started',
+ to: '/docs/getting-started'
+ },
+ {
+ label: 'User\'s Guide',
+ to: '/docs/user'
+ },
+ {
+ label: 'Contributor\'s Guide',
+ to: '/docs/developer'
+ },
+ {
+ label: 'Maintainer\'s Guide',
+ to: '/docs/maintainer'
+ },
+ {
+ label: 'Help Centre',
+ to: '/docs/support'
+ },
+ {
+ label: 'About',
+ to: '/docs/project/about'
+ },
+ ]
},
+
{
type: 'docSidebar',
label: 'Tools',
position: 'left',
sidebarId: 'toolsSidebar'
},
- {
- label: 'About',
- to: 'docs/about',
- position: 'left',
- },
{
type: 'dropdown',
to: '/blog',
@@ -274,7 +296,7 @@ const config: Config = {
},
{
label: 'About',
- to: '/docs/about',
+ to: '/docs/project/about',
},
{
label: 'Blog',
diff --git a/website/package.json b/website/package.json
index a80bd34..43c80ac 100644
--- a/website/package.json
+++ b/website/package.json
@@ -44,6 +44,12 @@
"liquidjs": "^10.20.1",
"typescript": "~5.2.2"
},
+ "$devDependenciesUrls": [
+ "https://www.npmjs.com/package/del-cli",
+ "https://www.npmjs.com/package/json",
+ "https://www.npmjs.com/package/liquidjs",
+ "https://www.npmjs.com/package/typescript"
+ ],
"browserslist": {
"production": [
">0.5%",
@@ -63,6 +69,7 @@
"hasCustomUser": "true",
"hasCustomMaintainer": "true",
"hasCustomDeveloper": "true",
+ "hasCustomAbout": "true",
"docusaurusTagline": "Cross-platform binary tools for software development, aimed at reproducible builds",
"docusaurusBaseUrl": "/"
},
diff --git a/website/sidebars.ts b/website/sidebars.ts
index 5a5b103..4f2f461 100644
--- a/website/sidebars.ts
+++ b/website/sidebars.ts
@@ -60,12 +60,38 @@ const sidebars: SidebarsConfig = {
id: 'maintainer/index',
label: 'Maintainer\'s Guides'
},
-
{
type: 'doc',
- id: 'about/index',
- label: 'About'
- }
+ id: 'support/index',
+ label: 'Help Centre'
+ },
+
+ {
+ type: 'category',
+ label: 'Project',
+ link: {
+ type: 'doc',
+ id: 'project/about/index',
+ },
+ collapsed: false,
+ items: [
+ {
+ type: 'doc',
+ id: 'project/about/index',
+ label: 'About'
+ },
+ {
+ type: 'doc',
+ id: 'project/history/index',
+ label: 'History'
+ },
+ {
+ type: 'link',
+ label: 'License',
+ href: 'https://opensource.org/license/MIT',
+ },
+ ]
+ },
],
toolsSidebar,
};