1
0
mirror of https://github.com/ZSCNetSupportDept/website.git synced 2025-10-29 01:15:04 +08:00

完善快速上手指南和README.md

This commit is contained in:
2024-08-23 13:52:19 +08:00
parent 0028075638
commit fe61443aeb
2 changed files with 25 additions and 1 deletions

View File

@@ -1,6 +1,9 @@
# 快速上手
修网的知识需要在实践中不断积累网维的wiki做为每一个网维成员经验的总结自然也需要不断的更新但是wiki本身大部分时间都是由开发组的仅仅几个人来维护难以时刻更新到最新情况所以我们想让网维的每个人都能加入wiki的维护这篇文章就是写给希望为wiki添砖加瓦却不太了解相关方法的小伙伴的希望这篇文章能够快速让你上手wiki的维护工作。
在这篇文章里我们将教你:\
将我们在github上的主仓库fork一份然后将fork仓库clone到你的电脑;修改网站源代码;将你的修改传回fork仓库提交pull request
:::info 信息
在正式开始编辑前,你可以看看我们的成品网站,每篇文章的下面会有一个`Edit This Page`的链接,是这篇文章的源代码,这里是网站的链接:[Click Me ](https://zscdev-demo.pages.dev/)
@@ -104,7 +107,16 @@ https://commonmark.org/ (英文)
你会发现所有文件的名字前面都有一个数字那就是文章在sidebar中出现的顺序增添文件请按照`order-filename.md`的格式修改名字。
在文件名前加一个下划线,系统就不会将文章加入成品网站中。
:::tip 提示
关于如何修改wiki的更多提示,可以去看docusaurus的官方文档[链接](https://docusaurus.cn)
:::
## 推送到仓库
在修改完毕并且在本地检查完毕后你需要将你的修改同步到你在github的远程fork仓库然后再提交一个pull request请求主仓库合并你在fork仓库所做的修改。
首先你需要验证你的身份让github允许你的电脑向它提交push
:::tip 提示
你可以使用github desktop或github cli来简化这个流程不过我们想让你在这个过程中学习SSH的用法如果你想方便一点直接跳到“使用github-cli”。