Skip to content

Commit 4e4b2d7

Browse files
committed
增加文档维护范围,添加CSL贡献指南链接
1 parent 8c62d6b commit 4e4b2d7

File tree

2 files changed

+37
-9
lines changed

2 files changed

+37
-9
lines changed

contributing/index.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Zotero 中文社区接受多种形式的贡献,请阅读这一份指南,以
1414

1515
:::
1616

17-
如果你觉得 Zotero 中文社区还可以,请分享给你的同学/同门/师兄弟姐妹/老师/网友
17+
如果你觉得 Zotero 中文社区还可以,请分享给你的同学 / 同门 / 师兄弟姐妹 / 老师 / 好友
1818

1919
我们网站的地址是:`zotero-chinese.com`,你也可以在百度、必应或谷歌上搜索“Zotero 中文社区”找到我们。(目前,百度的搜索效果较必应要差一些,我们正在努力改进)
2020

@@ -54,7 +54,7 @@ Zotero 中文社区接受多种形式的贡献,请阅读这一份指南,以
5454

5555
难度:⭐⭐
5656

57-
需要技能:
57+
需要技能:Markdown
5858

5959
:::
6060

@@ -74,7 +74,7 @@ Zotero 中文社区接受多种形式的贡献,请阅读这一份指南,以
7474

7575
难度:⭐⭐
7676

77-
需要技能:TypeScript
77+
需要技能:TypeScript (OR not)
7878

7979
:::
8080

@@ -92,7 +92,9 @@ Zotero 中文社区接受多种形式的贡献,请阅读这一份指南,以
9292

9393
:::
9494

95-
请参阅样式仓库的自述文件。
95+
请参阅 [样式仓库的自述文件](https://github.com/zotero-chinese/styles)
96+
97+
如果你需要修改 CSL 样式,可以阅读 [CSL 开发指南](../csl-dev-guide/index.md)
9698

9799
## 提交转换器
98100

@@ -104,6 +106,8 @@ Zotero 中文社区接受多种形式的贡献,请阅读这一份指南,以
104106

105107
:::
106108

109+
编写一个转换器,让 Zotero 导入中文文献更方便。
110+
107111
请参阅 [转换器仓库的自述文件](https://github.com/l0o0/translators_CN#readme)
108112

109113
## 提交搜索引擎文件
@@ -127,3 +131,9 @@ Zotero 中文社区接受多种形式的贡献,请阅读这一份指南,以
127131
:::
128132

129133
请参阅 [网站仓库的自述文件](https://github.com/zotero-chinese/website#readme)
134+
135+
## 参与 Zotero 社区的建设
136+
137+
Zotero 是一个全球化的社区,它由各个国家的学者共同组成,在参与 Zotero 中文社区建设之外,您也可以参与 Zotero 官方社区的建设,请阅读 [Get Involved With Zotero](https://www.zotero.org/getinvolved/) 了解详情。
138+
139+
特别地,如果你完善 Zotero 客户端的“中文”语言,可以加入 Zotero 官方在 Transifex 的翻译团队,请阅读 [Localization - Zotero Documentation](https://www.zotero.org/support/dev/localization) 以了解详情。

contributing/wiki.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ date: 2023-07-20 23:05:53
66

77
# 文档修改指南
88

9-
## 项目概览
9+
## 项目概述
1010

1111
本文档使用 Markdown 语法编写,Markdown 文件存储在 GitHub 上,使用 VitePress 作为静态页面生成器,通过 GitHub Actions 自动构建网站,并托管在 Netlify 上。
1212

13+
当然,您实际上不需要知道上面的名词代表的是什么,您只需要根据后续小节提供的 [修改方法](#修改方法),并参阅 [文档风格和语法指南](./markdown.md) ,就可以完成文档的贡献。
14+
1315
目前仓库地址为 <https://github.com/zotero-chinese/wiki/>
1416

1517
::: info 需要 GitHub 账号
@@ -18,13 +20,29 @@ date: 2023-07-20 23:05:53
1820

1921
:::
2022

23+
## 文档维护范围
24+
25+
文档的维护与更新主要包括几个方面:
26+
27+
- 修正错别字、语句不通等
28+
- 修正文档中的错误或不清晰的描述
29+
- 文档里出现“TODO”、“施工中”、“待办”等字样的内容
30+
- 我们在文档仓库里列出的 [待办项](https://github.com/zotero-chinese/wiki/issues)
31+
- 调整章节结构,使文档条理更清晰
32+
- 增加示例、专题或入门教程
33+
- 其他任何你认为有必要修改的地方
34+
35+
如果您期望调整章节结构或对文档进行较大规模的修改重构,希望您可以先在文档仓库的 ISSUE 里发布一个帖子,与我们讨论后再进行。
36+
37+
## 修改方法
38+
2139
::: tip 请根据实际需要选择修改方法
2240

2341
为了降低上手门槛,我们根据需要修改的量和难易程度提供了以下几种修改方法。
2442

2543
:::
2644

27-
## 方法 1:在 GitHub 上在线修改
45+
### 方法 1:在 GitHub 上在线修改
2846

2947
::: info 评价
3048

@@ -70,7 +88,7 @@ date: 2023-07-20 23:05:53
7088

7189
维护者将尽快审核这些修改。
7290

73-
## 方法 2:通过代码空间在线修改 <Badge text="推荐" />
91+
### 方法 2:通过代码空间在线修改 <Badge text="推荐" />
7492

7593
::: info 评价
7694

@@ -82,9 +100,9 @@ date: 2023-07-20 23:05:53
82100

83101
例如你需要添加一篇文章,上传一些图片等,且对 Git 不甚了解,那么可以使用这种方式在线修改,这可以避免你下载很多软件。
84102

85-
请参考 [使用 `GitHub 代码空间` 修改文档](./github-codespace.md) <Badge text="推荐" /> 或 [使用 vscode.dev 指南](vscode-dev.md)
103+
请参考 [使用 `GitHub 代码空间` 修改文档](./github-codespace.md)
86104

87-
## 方法 3:离线修改
105+
### 方法 3:离线修改
88106

89107
::: info 评价
90108

0 commit comments

Comments
 (0)