1
0
mirror of https://github.com/ZSCNetSupportDept/website.git synced 2025-10-28 17:05:03 +08:00

增加网站开发的工作流程

This commit is contained in:
2024-08-21 19:09:05 +08:00
parent b118d864e4
commit 417f379d40
2 changed files with 8 additions and 1 deletions

View File

@@ -2,7 +2,13 @@
## 技术
网站基于Docusaurus开发,一个静态网页生成的框架尤其对于生成技术文档来说它提供了一个美观现代的前端界面这个项目本身是一个react.js应用生成网页时只要输入`npm run build`便可以在build目录里构建网站的所有资源以进一步部署关于详细的配置可以去看官方的文档[文档连接](https://www.docusaurus.cn/docs/category/guides)
## 工作流程
基本上我们需要把markdown文件放在目录里面系统就会根据目录的结构自动生成网页但是我们必须写好配置文件如果我们想自定义网站的外观的话也需要好好研究一下配置文件有关文档还在编写中
基本上我们需要把markdown文件放在目录里面系统就会根据目录的结构自动生成网页但是我们必须写好配置文件如果我们想自定义网站的外观的话也需要好好研究一下配置文件有关文档还在编写中 \
开发组网站的开发流程基本如下:
1. 将源代码仓库的最新版本拉取到本地对仓库的内容进行修改最终在本地的master分支上commit,
2. 运行`npm start``https://localhost:3000`上运行基于改动构建的预览版本
3. 测试改动确保一切正常后push到github上
4. demo网站会自动根据github上的msater分支构建网页构成开发组网站的预览版本
5. 积累几个改动后,在本地运行`npm run deploy`将网页构建好推送给github上的`build`分支,网站服务器自动获取并更新,构成开发组网站的正式版本
## 目录
所有的文档文件都储存在docs文件夹下\
所有的公告文件都储存在blog文件夹下\

View File

@@ -16,6 +16,7 @@
- src文件夹存放了独立于文档和blog的静态页面
- docs文件夹存放了所有的文档目前有wiki和开发组文档两个docs
- blog文件夹存放了可以显示在“公告”板块的文章
所有的文档都以Markdown格式书写其实也可以用MDX格式
### 前缀
所有文件都有一个数字前缀,这是文章在成品网站中的顺序,文件请按照`order-filename.md`的格式命名