Skip to content

Commit 71a1e3f

Browse files
ilg-ulilg-ul
committed
website: re-generate commons
1 parent c252e47 commit 71a1e3f

File tree

104 files changed

+1337
-715
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+1337
-715
lines changed

‎website/README.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,3 @@ The folder was created with:
88
```sh
99
npx create-docusaurus website classic --typescript
1010
```
11-
12-
## docusaurus-plugin-typedoc
13-
14-
This plugin uses [TypeDoc](https://typedoc.org) to generate
15-
the reference as markdown pages in `docs/api`.
16-
17-
- https://typedoc-plugin-markdown.org/plugins/docusaurus
18-
19-
```sh
20-
cd website
21-
npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
22-
```
23-
24-
[!NOTE]
25-
There is a new spec ([TSDoc](https://tsdoc.org)), pushed by
26-
Microsoft, slightly different, for example there are no
27-
categories or groups.
28-
29-
[!NOTE]
30-
There is also another plugin, `docusaurus-plugin-typedoc-api`, but
31-
it is no longer maintained.

‎website/blog/_common/_deprecation-notices-glib-2.27.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
{/* DO NOT EDIT! */}
32
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
43

‎website/blog/_common/_deprecation-notices-glib-2.28.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
{/* DO NOT EDIT! */}
32
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
43

‎website/blog/_common/_download-analytics.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,16 @@ import Image from '@theme/IdealImage';
77

88
## Analytics
99

10+
1011
- GitHub [xpack-dev-tools/riscv-none-elf-gcc-xpack](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/)
1112
- this release <a href={`https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/v${props.version}/`} ><Image img={`https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/v${props.version}/total`} alt='Github Release' /></a>
1213
- all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/total)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases)
1314
- deprecated xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-embed-gcc-xpack/total)](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases)
1415
- all GNU MCU Eclipse releases [![Github All Releases](https://img.shields.io/github/downloads/gnu-mcu-eclipse/riscv-none-gcc/total)](https://github.com/gnu-mcu-eclipse/riscv-none-gcc/releases)
1516
- [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=riscv-none-elf-gcc-xpack) (grouped by release)
1617
- npmjs.com [@xpack-dev-tools/riscv-none-elf-gcc](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc)
17-
- last month downloads [![NPM Downloads](https://img.shields.io/npm/dw/%40xpack-dev-tools%2Friscv-none-elf-gcc)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/)
18-
- total downloads [![NPM Downloads](https://img.shields.io/npm/d18m/%40xpack-dev-tools%2Friscv-none-elf-gcc)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/)
18+
- last month downloads [![NPM Downloads](https://img.shields.io/npm/dm/%40xpack-dev-tools%2Friscv-none-elf-gcc?color=green)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/)
19+
- total downloads [![NPM Downloads](https://img.shields.io/npm/d18m/%40xpack-dev-tools%2Friscv-none-elf-gcc?color=green)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/)
1920
- all @xpack-dev-tools deprecated releases [![npm](https://img.shields.io/npm/dt/@xpack-dev-tools/riscv-none-embed-gcc.svg)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-embed-gcc/)
2021
- all @gnu-mcu-eclipse releases [![npm](https://img.shields.io/npm/dt/@gnu-mcu-eclipse/riscv-none-gcc.svg)](https://www.npmjs.com/package/@gnu-mcu-eclipse/riscv-none-gcc/)
2122

‎website/docs/_common/_branches-details.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
<details>
7+
<summary>Branches</summary>
8+
9+
The project uses multiple branches:
10+
11+
- `master`, not actively used
12+
- `xpack`, with the latest stable version (default)
13+
- `xpack-development`, with the current development version
14+
- `website`, with the current content of the website; pushes to this branch automatically trigger publishes the main website
15+
- `development`, with the current content of the preview website; pushes to this branch automatically trigger publishes the preview website
16+
17+
All development is done in the `xpack-development` branch, and contributions via
18+
Pull Requests should be directed to this branch.
19+
20+
When new releases are published, the `xpack-development` branch is merged
21+
into `xpack`.
22+
23+
</details>

‎website/docs/_common/_build-website-locally.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
### Build the static website locally
7+
8+
Validate the website content in a local build via the npm **build** script:
9+
10+
```sh
11+
npm run build -C website
12+
```
13+
14+
Fix any broken links, if any.

‎website/docs/_common/_code-formatting.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
## Code formatting
7+
8+
As formatting style, the library uses a
9+
[.clang-format](https://clang.llvm.org/docs/ClangFormat.html)
10+
configuration file based on the GNU style.
11+
12+
Code formatting is done using `clang-format --style=file`, either manually
13+
from a script, or automatically from Visual Studio Code, or the Eclipse
14+
CppStyle plug-in.
15+
16+
:::info
17+
18+
Visual Studio Code can directly utilise the `.clang-format` file in the
19+
**Format Document** command.
20+
21+
:::
22+
23+
:::tip
24+
25+
Always reformat the source files that were changed before committing
26+
them to the repository.
27+
28+
:::

‎website/docs/_common/_continuous-integration.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
The library is
7+
CI tested on every push via
8+
[GitHub Actions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/actions),
9+
on Ubuntu, macOS, and Windows.
10+
11+
The tests run on 32 and 64-bit bare-metal platforms (Arm Cortex-M0,
12+
Cortex-M3, Cortex-M4F, Cortex-M7F, Cortex-A15, Cortex-A72, RISC-V RV32IMAC,
13+
RV64IMAFDC), and natively, with GCC and LLVM/clang.

‎website/docs/maintainer/_common/_generate-top-commons.mdx renamed to ‎website/docs/_common/_generate-top-commons.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
13

24
{/* ------------------------------------------------------------------------ */}
35

@@ -14,4 +16,3 @@ Run the top **generate-top-commons** npm script to update the
1416

1517
- stage GitHub workflows and `package.json` files (top and from `build-assets`)
1618
- **commit** with the message _**re-generate top commons to bump deps**_
17-

‎website/docs/_common/_generate-website-commons.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{/* DO NOT EDIT! */}
2+
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}
3+
4+
{/* ------------------------------------------------------------------------ */}
5+
6+
### Update the website commons
7+
8+
Run the **generate-website-commons** npm script from `website/package.json`
9+
in the project folder.
10+
11+
```sh
12+
npm run generate-website-commons -C website
13+
```

0 commit comments

Comments
 (0)