文档修改指南
项目概览
本文档使用 Markdown 语法编写,Markdown 文件存储在 GitHub 上,使用 VitePress 作为静态页面生成器,通过 GitHub Actions 自动构建网站,并托管在 Netlify 上。
目前仓库地址为 https://github.com/zotero-chinese/wiki/ 。
需要 GitHub 账号
文档源码开源托管在 GitHub 上,因此读者需要一个 GitHub 账户才能提交 PR。
请根据实际需要选择修改方法
为了降低上手门槛,我们根据需要修改的量和难易程度提供了以下几种修改方法。
方法 1:在 GitHub 上在线修改
评价
难度:⭐
适用于修改简单的别字、语句不通或不清晰的描述等。
在线修改
打开需要修改的文档网页,点击末尾左下角的 “在 GitHub 上编辑此页”,网页会自动跳转到 GitHub 编辑文档源码的页面。
如果你是第一次贡献,则会提示需要 fork 才能继续,请点击 “Fork this repositiry” 继续即可。
编辑需要修改的地方,文档风格和 Markdown 语法请参阅 文档风格指南 #Markdown 语法。
提交修改
修改完后,点击右上角的
Commit Changes...
,在弹窗中在下方的 “Commit changes” 中输入有关此次修改的标题和具体描述。然后点击“Propose changes”。
提交 PR
在 “Comparing changes” 页面中,,点击“Create Pull request”。
输入此 PR 的标题和具体描述。点击 “Create pull request” 即可。
PR 提交后,CI 工具会自动对提交的 PR 生成一个预览链接并评论在 PR 中,可以在此预览修改的结果。
维护者将尽快审核这些修改。
方法 2:通过代码空间在线修改 推荐
评价
难度:⭐⭐
适用于一般修改。
例如你需要添加一篇文章,上传一些图片等,且对 Git 不甚了解,那么可以使用这种方式在线修改,这可以避免你下载很多软件。
请参考 使用 GitHub 代码空间
修改文档 推荐 或 使用 vscode.dev 指南。
方法 3:离线修改
评价
难度:⭐⭐⭐
适用于维护者。
如果你需要做较大量修改,例如增加几篇文章,或长期贡献/维护仓库,且对 Git 有一些了解,可以采用这种方式:完全本地修改,可以在本地预览修改的效果,修改后再推送到 GitHub。
请参考 完全构建指南。
注意事项
- Commit 的注释信息应该是描述性的
- 希望读者对审稿人/维护者的评论和意见保持开放的心态,并努力改进代码或文档
- 新的 PR 不一定会及时审核,取决于审稿人/维护者的当时的工作时间