mirror of
https://github.com/ZSCNetSupportDept/website.git
synced 2025-10-29 01:15:04 +08:00
准备新的开发组文档,初步手机端访问支持
原来的在docs/devdocs/_legacy目录下面
This commit is contained in:
22
docs/devdocs/_legacy/02-网站/02-开发组网站/02-开发组网站-概览.md
Normal file
22
docs/devdocs/_legacy/02-网站/02-开发组网站/02-开发组网站-概览.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# 开发组网站-概览
|
||||
## 技术
|
||||
网站基于Docusaurus开发,一个静态网页生成的框架,尤其对于生成技术文档来说,它提供了一个美观,现代的前端界面,这个项目本身是一个react.js应用,生成网页时只要输入:`npm run build`便可以在build目录里构建网站的所有资源,以进一步部署,关于详细的配置,可以去看官方的文档:[文档连接](https://www.docusaurus.cn/docs/category/guides)
|
||||
## 工作流程
|
||||
基本上,我们需要把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文件夹下\
|
||||
所有的静态页面都储存在src/pages文件夹下\
|
||||
所有的媒体文件都储存在static文件夹下,供用户下载的资源也储存在这里\
|
||||
|
||||
docusaurus.config.js是项目的配置文件,配置格式请参照官方文档
|
||||
## 部署
|
||||
目前不确定
|
||||
## 注意事项
|
||||
最好还是看官方文档
|
||||
Reference in New Issue
Block a user