Skip to content

Commit ff26ff1

Browse files
committed
Remove obsolete TODO.md file and update contributing guidelines in SMD files to reflect new formatting standards. Change section titles for consistency and clarify local preview instructions using 'zine' instead of 'Hugo'.
1 parent 0b1455b commit ff26ff1

File tree

5 files changed

+29
-20
lines changed

5 files changed

+29
-20
lines changed

TODO.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

content/community.smd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.layout = "index.shtml",
66
.draft = false,
77
---
8-
TODO: issue
8+
99
[让我们一起探索 Zig 的魅力,推动 Zig 在中文社区内的发展!]($text.attrs('center','large','bold'))
1010

1111
# [网站更新日志]($section.id('website-update-log'))

content/contributing.smd

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,30 @@ Zig 中文社区是一个开放的组织,我们致力于推广 Zig 在中文
1212
2. 改进 zigcc 组织下的开源项目,这是 [open issues](https://github.com/search?q=state%3Aopen+org%3Azigcc++NOT+%E6%97%A5%E6%8A%A5&type=issues&ref=advsearch)
1313
3. 参与不定期的线上会议 TODO
1414

15-
# [供稿方式]($section.id('供稿方式'))
15+
# [供稿方式]($section.id('contribute'))
1616

1717
1. Fork 仓库 https://github.com/zigcc/zigcc.github.io
18-
2. 在 `content/post` 内添加自己的文章(md 或 org 格式均可),文件命名为: `${YYYY}-${MM}-${DD}-${SLUG}.md`
18+
2. 在 `content/post` 内添加自己的文章(smd格式),文件命名为: `${YYYY}-${MM}-${DD}-${SLUG}.smd`
1919
3. 文件开始需要包含一些描述信息,例如:
2020

2121
```
2222
---
23-
title: 欢迎 Zig 爱好者向本网站供稿
24-
author: 刘家财
25-
date: '2023-09-05T16:13:13+0800'
23+
.title = "文章标题",
24+
.date = @date("2025-06-05T16:00:00+0800"),
25+
.author = "刘家财",
26+
.layout = "post.shtml",
27+
.draft = false,
28+
.custom = {
29+
.math = true, // 如果你要用到数学公式,请 设置 math 为 true; 否则可以忽略
30+
.mermaid = true, // 如果你要用到 mermaid 图表,请设置 mermaid 为 true; 否则可以忽略
31+
},
2632
---
2733
```
2834

2935
# [本地预览]($section.id('本地预览'))
30-
TODO
36+
37+
首先你得安装 `zine`,安装方法见 [Quick Start](https://zine-ssg.io/quickstart/),或者你也可以使用包管理器安装(aur, ...)
38+
3139
```bash
3240
zine
3341
```

content/post/2023-09-05-bog-gc-1.smd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
.layout = "post.shtml",
66
.draft = false,
77
.custom = {
8-
.math = true, // TODO: mathjax
8+
.math = true,
99
.mermaid = true,
1010
},
1111
---

content/post/2023-09-05-hello-world.smd

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,26 @@
1111
- [ZigCC 网站](https://ziglang.cc)
1212
- [ZigCC 公众号](https://github.com/zigcc/.github/raw/main/zig_mp.png)
1313

14-
# [供稿方式]($section.id('供稿方式'))
15-
16-
TODO
14+
# [供稿方式]($section.id('contribute'))
1715

1816
1. Fork 仓库 https://github.com/zigcc/zigcc.github.io
19-
2. ~~在 `content/post` 内添加自己的文章(md 或 org 格式均可),文件命名为: `${YYYY}-${MM}-${DD}-${SLUG}.md`~~
20-
3. ~~文件开始需要包含一些描述信息,例如[本文件](https://github.com/zigcc/zigcc.github.io/tree/main/content/post/2023-09-05-hello-world.md)中的:~~
17+
2. 在 `content/post` 内添加自己的文章(smd格式),文件命名为: `${YYYY}-${MM}-${DD}-${SLUG}.smd`
18+
3. 文件开始需要包含一些描述信息,例如
2119

2220
```
2321
---
24-
title: 欢迎 Zig 爱好者向本网站供稿
25-
author: 刘家财
26-
date: '2023-09-05T16:13:13+0800'
22+
.title = "文章标题",
23+
.date = @date("2025-06-05T16:00:00+0800"),
24+
.author = "刘家财",
25+
.layout = "post.shtml",
26+
.draft = false,
27+
.custom = {
28+
.math = true, // 如果你要用到数学公式,请 设置 math 为 true; 否则可以忽略
29+
.mermaid = true, // 如果你要用到 mermaid 图表,请设置 mermaid 为 true; 否则可以忽略
30+
},
2731
---
2832
```
2933

3034
# [本地预览]($section.id('local-preview'))
3135

32-
在写完文章后,可以使用 [Hugo](https://gohugo.io/) 进行本地预览,只需在项目根目录执行 `hugo server`,这会启动一个 HTTP 服务,默认的访问地址是: http://localhost:1313/
36+
在写完文章后,可以使用 [zine](https://zine-ssg.io/) 进行本地预览,只需在项目根目录执行 `zine`,这会启动一个 HTTP 服务,默认的访问地址是: http://localhost:1990/

0 commit comments

Comments
 (0)