From fe61443aebbcec88d89bbf27630310d9c6e1d474 Mon Sep 17 00:00:00 2001 From: govolokatliai Date: Fri, 23 Aug 2024 13:52:19 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84=E5=BF=AB=E9=80=9F=E4=B8=8A?= =?UTF-8?q?=E6=89=8B=E6=8C=87=E5=8D=97=E5=92=8CREADME.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 14 +++++++++++++- docs/devdocs/02-网站/02-开发组网站/快速上手.md | 12 ++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 51b2389..b14430d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,19 @@ ## 依赖 `nodejs >= 18.0` ## 构建 -不同于传统的静态网页生成器，本项目不需要额外加装构建工具，生成器和内容本身加起来就是一个单独的react.js应用，所以理论上你只需要把这个repo pull到本地，再用npm构建即可，运行`npm run docusaurus`来运行框架本身提供的一些脚本\ +不同于传统的静态网页生成器，本项目不需要额外加装构建工具，生成器和内容本身加起来就是一个单独的react.js应用，所以理论上你只需要把这个repo pull到本地，再用npm构建即可，运行`npm run docusaurus`来运行框架本身提供的一些脚本. +要构建可以拿去部署的静态网站资源，运行： + +``` + +git clone https://github.com/ZSCNetSupportDept/website + +npm install + +npm run docusaurus build + +``` + 运行`npm run docusaurus deploy`可以自动构建静态网站，并且push到`build`上\ https://zscdev-demo.pages.dev 是本仓库的一个demo网站，基于master构建而不是build ## 部署 diff --git a/docs/devdocs/02-网站/02-开发组网站/快速上手.md b/docs/devdocs/02-网站/02-开发组网站/快速上手.md index 96b4947..960d44b 100644 --- a/docs/devdocs/02-网站/02-开发组网站/快速上手.md +++ b/docs/devdocs/02-网站/02-开发组网站/快速上手.md @@ -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”。