Skip to content

Commit f909929

Browse files
committed
feat: update README files
1 parent 4a96995 commit f909929

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Windows home page from 2001 - 2004:
2323
- [Reference 1, Windows XP home from late 2001](https://web.archive.org/web/20011211230629/http://microsoft.com/windowsxp/default.asp)
2424
- [Reference 2, Windows XP mid-cycle home from 2004](https://web.archive.org/web/20040204080626/http://www.microsoft.com/china/windows/default.mspx)
2525

26-
Technically speaking, this a server-side rendered site built with Nuxt.
26+
Technically speaking, this a statically generated site built with Nuxt.
2727

2828
This website is not yet optimised for mobile, legacy (Afterglow-targeted),
2929
and functionally-limited browsers. We are currently evaluating plans to
@@ -44,19 +44,19 @@ To install Node.js + NPM on AOSC OS:
4444
oma install nodejs
4545
```
4646

47-
Then, build and serve the website locally:
47+
Then, build and preview the website locally:
4848

4949
```
50-
npm run build
51-
node .output/server/index.mjs
50+
npm run generate
51+
npm run preview
5252
```
5353

5454
Submitting news
5555
---
5656

57-
All news articles are written in Markdown and stored in `/content/news`, with
58-
extra assets (images, etc.) stored in `/assets/...`. All assets should be
59-
referenced from the site (`/assets/...`, not `https://...`).
57+
All news articles are written in Markdown and stored in `/content/{language}/news`, with
58+
extra assets (images, etc.) stored in `/public/...`. All assets should be
59+
referenced from the site (`/...`, not `https://...`).
6060

6161
News articles should contain a header:
6262

@@ -83,8 +83,9 @@ home: true
8383

8484
### Localising news articles
8585

86-
To localise a news article, use a language code suffix such as `.zh-cn`, i.e.:
86+
To localize a news article, just add a file with the same name to the
87+
corresponding language folder such as `/content/zh/`, i.e.:
8788

8889
```
89-
2024-09-18-aosc-os-relnote.zh-cn.md
90+
/content/zh/news/2024-09-18-aosc-os-relnote.md
9091
```

README.zh-cn.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
- [参考甲:Windows XP 主页(2001 年末)](https://web.archive.org/web/20011211230629/http://microsoft.com/windowsxp/default.asp)
1616
- [参考乙:Windows XP 中期主页(2004 年)](https://web.archive.org/web/20040204080626/http://www.microsoft.com/china/windows/default.mspx)
1717

18-
技术架构方面,该网站是使用 Nuxt 构建,采用服务端渲染技术
18+
技术架构方面,该网站是使用 Nuxt 构建,采用静态网站生成技术
1919

2020
目前网站亦未对移动端、低性能(星霞 OS 目标)设备及功能受限的浏览器优化,我们计划在后续研判是否通过实现专用网站解决此问题。
2121

@@ -30,17 +30,17 @@
3030
oma install nodejs
3131
```
3232

33-
而后,使用如下命令启动网站构建及服务
33+
而后,使用如下命令启动网站构建及预览
3434

3535
```
36-
npm run build
37-
node .output/server/index.mjs
36+
npm run generate
37+
npm run preview
3838
```
3939

4040
提交新闻
4141
---
4242

43-
本站新闻使用 Markdown 格式编写,存放于 `/content/news`;额外文件(如图片等)存放于 `/assets/...`。引用额外文件时,应使用站内引用(`/assets/...`)而非站外引用(`https://...`)。
43+
本站新闻使用 Markdown 格式编写,存放于 `/content/{language}/news`;额外文件(如图片等)存放于 `/public/...`。引用额外文件时,应使用站内引用(`/...`)而非站外引用(`https://...`)。
4444

4545
新闻文件均带有文件头,如下例:
4646

@@ -67,8 +67,8 @@ home: true
6767

6868
### 新闻本地化
6969

70-
本地化新闻文章时,在文件名后加语言代号作为后缀即可(如 `.zh-cn`):
70+
本地化新闻文章时,在对应语言文件夹下添加同名文件即可(如 `/content/en/`):
7171

7272
```
73-
2024-09-18-aosc-os-relnote.zh-cn.md
73+
/content/en/news/2024-09-18-aosc-os-relnote.md
7474
```

0 commit comments

Comments
 (0)