Skip to content

Commit fe6dcd4

Browse files
authored
重写贡献指南 (#190)
* 拆分贡献指南为参与指南和文档贡献指南 * 移除无用badge * 完善贡献指南 * 启用智能提交 * codespace默认打开贡献指南 * 压缩图片
1 parent 93f0c07 commit fe6dcd4

33 files changed

+466
-132
lines changed

.devcontainer/devcontainer.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@
3636
"yzhang.markdown-all-in-one",
3737
"SimonSiefke.svg-preview"
3838
]
39+
},
40+
"codespaces": {
41+
"openFiles": [
42+
"src/contributing/wiki.md",
43+
"src/contributing/markdown.md",
44+
"src/contributing/github-codespace.md"
45+
]
3946
}
4047
}
4148

.github/contributing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 贡献指南
2+
3+
<!-- 此文件仅作为 GitHub 社区健康文件使用 -->
4+
5+
请查阅 [贡献指南 - Zotero 中文社区](https://zotero-chinese.com/contributing/)

.vitepress/config/sidebar.ts

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,14 @@ export const sidebar = {
155155
{ text: "脚手架", link: "/translator-dev-guide/scaffold" },
156156
],
157157
"/contributing/": [
158-
{ text: "贡献指南", link: "/contributing/" },
159-
{ text: "语法风格", link: "/contributing/markdown" },
160-
{ text: "在线修改", link: "/contributing/vscode-dev" },
161-
{ text: "构建指南", link: "/contributing/build" },
158+
{ text: "参与指南", link: "/contributing/" },
159+
{ text: "文档贡献指南", link: "/contributing/wiki" },
160+
{ text: "文档语法风格", link: "/contributing/markdown" },
161+
{
162+
text: "通过 GitHub 代码空间在线修改文档",
163+
link: "/contributing/github-codespace",
164+
},
165+
{ text: "通过 VS Code 在线修改文档", link: "/contributing/vscode-dev" },
166+
{ text: "完整构建指南", link: "/contributing/build" },
162167
],
163168
} satisfies DefaultTheme.Sidebar;

.vscode/settings.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"git.autofetch": true,
1717
"git.autoStash": true,
1818
"git.pruneOnFetch": true,
19+
"git.enableSmartCommit": true,
1920
"git.branchProtection": ["main"],
2021
"git.branchProtectionPrompt": "alwaysPrompt",
2122
// "git.branchRandomName.enable": true,
@@ -31,7 +32,7 @@
3132
"markdown.validate.fileLinks.enabled": "error",
3233
"markdown.validate.referenceLinks.enabled": "ignore",
3334
"markdown.copyFiles.destination": {
34-
"**/*": "${documentWorkspaceFolder}/assets/"
35+
"**/*": "${documentWorkspaceFolder}/assets/images/"
3536
},
3637
"markdown.updateLinksOnFileMove.enabled": "always",
3738
"markdown.editor.pasteUrlAsFormattedLink.enabled": "smart",
@@ -50,7 +51,7 @@
5051
/** custom begin **/
5152

5253
// npm
53-
"node_modules": true,
54+
// "node_modules": true,
5455
// "package.json": true
5556
"package-lock.json": true,
5657
"pnpm-lock.yaml": true,

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44
[![GitHub contributors](https://img.shields.io/github/contributors-anon/zotero-chinese/wiki)](#贡献者)
55
[![GitHub License](https://img.shields.io/github/license/zotero-chinese/wiki)](#协议)
66
[![GitHub repo size](https://img.shields.io/github/repo-size/zotero-chinese/wiki)](#zotero-中文文档仓库)
7-
87
[![GitHub last commit (branch)](https://img.shields.io/github/last-commit/zotero-chinese/wiki/main)](#zotero-中文文档仓库)
9-
[![Netlify Status](https://api.netlify.com/api/v1/badges/aaa3fdac-5809-409e-b99d-012a232fed18/deploy-status)](https://app.netlify.com/sites/zotero-zh/deploys)
10-
[![Main Action](https://github.com/zotero-chinese/wiki/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/zotero-chinese/wiki/actions/workflows/main.yml)
11-
[![pages-build-deployment](https://github.com/zotero-chinese/zotero-chinese.github.io/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/zotero-chinese/zotero-chinese.github.io/actions/workflows/pages/pages-build-deployment)
8+
9+
[![在 GitHub Codespaces 中打开](https://github.com/codespaces/badge.svg)](https://codespaces.new/zotero-chinese/wiki?quickstart=1)
1210

1311
本仓库存储 Zotero 中文社区所建立的各种文档,包括 Zotero 用户文档、Zotero 插件开发文档、CSL 规范中文译文等。
1412

13.4 KB
Loading
105 KB
Loading
87.3 KB
Loading
103 KB
Loading
79 KB
Loading

0 commit comments

Comments
 (0)