Skip to content

Commit db8f0cd

Browse files
committed
website: re-generate commons
1 parent c1c2d8a commit db8f0cd

7 files changed

Lines changed: 1118 additions & 648 deletions

File tree

website/blog/_templates/blog-post-release-part-1-liquid.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ download_url: https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releas
3434
import {PageMetadata} from '@docusaurus/theme-common';
3535
import Image from '@theme/IdealImage';
3636
import CodeBlock from '@theme/CodeBlock';
37+
import Tabs from '@theme/Tabs';
38+
import TabItem from '@theme/TabItem';
39+
40+
import customField from '@site/src/libs/customField';
3741

3842
import Prerequisites from './_common/_prerequisites-glib-2.28.mdx';
3943
import DeprecationNotices from './_common/_deprecation-notices-glib-2.28.mdx';
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,78 @@
11

2+
## Folders hierarchy
3+
4+
After install, the package creates a hierarchy of folders like the following
5+
(only the first two depth levels are shown):
6+
7+
{%- assign platforms_array = platforms | split: "," %}
8+
9+
{%- assign names_array = "" | split: "" %}
10+
11+
{%- for platform in platforms_array %}
12+
{%- case platform %}
13+
{%- when "win32-x64" %}
14+
{%- assign names_array = names_array | concat: "Windows" %}
15+
{%- when "darwin-x64", "darwin-arm64" %}
16+
{%- assign names_array = names_array | concat: "macOS" %}
17+
{%- when "linux-x64", "linux-arm64", "linux-arm" %}
18+
{%- assign names_array = names_array | concat: "GNU/Linux" %}
19+
{%- endcase %}
20+
{%- endfor %}
21+
22+
{%- assign names_array = names_array | uniq %}
23+
24+
<Tabs groupId="operating-systems">
25+
26+
{%- for name in names_array %}
27+
{%- case name %}
28+
{%- when "Windows" %}
29+
30+
<TabItem value="windows" label="Windows" default>
31+
32+
<CodeBlock language="console"> {
33+
`C:\> tree /f %USERPROFILE%\\AppData\\Roaming\\xPacks\\@{{packageScope}}\\{{packageName}}\\${frontMatter.version}.${frontMatter.npm_subversion}\\.content
34+
Folder PATH listing
35+
Volume serial number is B02D-925C
36+
├── README.md
37+
├── bin
38+
TODO
39+
`} </CodeBlock>
40+
41+
</TabItem>
42+
43+
{%- when "macOS" %}
44+
45+
<TabItem value="macos" label="macOS">
46+
47+
<CodeBlock language="console"> {
48+
`$ tree -L 2 ~/Library/xPacks/\{{packageScopedName}}/${frontMatter.version}.${frontMatter.npm_subversion}/.content/
49+
/Users/ilg/Library/xPacks/\{{packageScopedName}}/${frontMatter.version}.${frontMatter.npm_subversion}/.content/
50+
├── README.md
51+
├── bin
52+
TODO
53+
`} </CodeBlock>
54+
55+
</TabItem>
56+
57+
{%- when "GNU/Linux" %}
58+
59+
<TabItem value="linux" label="GNU/Linux">
60+
61+
<CodeBlock language="console"> {
62+
`$ tree -L 2 ~/.local/xPacks/\{{packageScopedName}}/${frontMatter.version}.${frontMatter.npm_subversion}/.content/
63+
/home/ilg/.local/xPacks/\{{packageScopedName}}/${frontMatter.version}.${frontMatter.npm_subversion}/.content/
64+
├── README.md
65+
├── bin
66+
TODO
67+
`} </CodeBlock>
68+
69+
</TabItem>
70+
71+
{%- endcase %}
72+
{%- endfor %}
73+
74+
</Tabs>
75+
276
<DeprecationNotices/>
377

478
<DownloadAnalytics version={frontMatter.version}/>

website/docs/maintainer/_common/_content.mdx

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -610,13 +610,6 @@ watching the riscv-none-elf-gcc-xpack project.
610610

611611
<CommonPrepareNewBlogPost />
612612

613-
### Update the web install page
614-
615-
- Check and possibly update the output of the `--version` runs in
616-
- `website/docs/install/_project/_automatic-install-quick-test.mdx`
617-
- `website/docs/install/_project/_manual-install-quick-test.mdx`
618-
- **Commit** with the message _**website: update quick tests**_
619-
620613
### Check the list of links in top package.json
621614

622615
- Open the top `package.json` file

website/docs/maintainer/_common/_prepare-new-blog-post.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
```sh
1111
npm run generate-website-blog-post -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git/website
1212
```
13-
- Edit the front matter properties (the `description` property)
14-
- Select the correct summary (maintenance vs. new release)
13+
- Fix the TODO in the front matter `description` property (select maintenance vs. new release)
14+
- Fix the TODO in the summary (select maintenance vs. new release)
1515
- Add entries in the **Bug fixes**; utilise the following syntax
1616
```
1717
- [[#N](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/issues/N)]:
1818
```
19-
- Copy/paste the folder structures from the installation guide
19+
- Copy/paste the **folder hierarchies** from the `website/docs/_project/_folders-hierarchies-*.mdx` files
2020
- **Commit** with the message _**website: blog post release 14.2.0-3.1 published**_

website/docusaurus.config.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ const config: Config = {
4747

4848
onBrokenAnchors: 'throw',
4949
onBrokenLinks: 'throw',
50-
onBrokenMarkdownLinks: 'throw',
5150

5251
onDuplicateRoutes: 'throw',
5352

@@ -64,7 +63,10 @@ const config: Config = {
6463
},
6564

6665
markdown: {
67-
format: 'detect'
66+
format: 'detect',
67+
hooks: {
68+
onBrokenMarkdownLinks: 'throw'
69+
}
6870
},
6971

7072
plugins: [

0 commit comments

Comments
 (0)