mirror of
https://github.com/ZSCNetSupportDept/website.git
synced 2025-10-28 17:05:03 +08:00
更新开发组文档,完善wiki的错误码板块,优化了结构
This commit is contained in:
7
docs/devdocs/02-网维报修系统/01-概述.md
Normal file
7
docs/devdocs/02-网维报修系统/01-概述.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
|
||||
description: 项目的概述
|
||||
|
||||
---
|
||||
# 概述
|
||||
网维原来的老报修系统从13年开始开发,16年完成的第二版一直用到了现在2025年,确实有必要更新了 ,
|
||||
3
docs/devdocs/02-网维报修系统/_category_.json
Normal file
3
docs/devdocs/02-网维报修系统/_category_.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"description": "..."
|
||||
}
|
||||
@@ -1 +1,8 @@
|
||||
# 网维报修系统
|
||||
网维的新报修系统
|
||||
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList className="docs-card" />
|
||||
|
||||
|
||||
24
docs/devdocs/03-开发组网站/01-概述.md
Normal file
24
docs/devdocs/03-开发组网站/01-概述.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
|
||||
description: 项目的概述
|
||||
|
||||
---
|
||||
# 概述
|
||||
项目的概述
|
||||
## 介绍
|
||||
本站采用Docusaurus框架,Docusaurus是一个静态网页生成器,也就是说,项目的构建目标是一堆静态网页文件,拿去给HTTP服务器部署;
|
||||
|
||||
要想为网站写内容,只需要把写好的Markdown丢进项目特定的路径里,Docusaurus生成器会自动把文件变成成品网站;这样我们可以专注内容写作,不用担心其它的;
|
||||
|
||||
框架本身使用React,本地构建时需要对应的前端工具链;官方要求的运行时为`Node.js >= 18.0`,至于包管理器,就看个人喜好了,我们以`npm`举例;
|
||||
## 结构
|
||||
从项目根目录下开始看起:
|
||||
- `docs`:存放wiki和开发组文档的内容
|
||||
- `blog`:存放文章的内容
|
||||
- `src`:存放其它不是Markdown,但是又属于网站内容的部分;例如独立页面(如首页),自定义CSS和React Component等
|
||||
- `static`:存放静态文件,内容会被原样拷贝到构建目标的根目录下
|
||||
- `docusaurus.config.js`:主配置文件
|
||||
- `sidebars.js`:Sidebar(就是访问`docs`下文档时出现在左边的栏目)配置文件
|
||||
|
||||
|
||||
|
||||
3
docs/devdocs/03-开发组网站/_category_.json
Normal file
3
docs/devdocs/03-开发组网站/_category_.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"description": "..."
|
||||
}
|
||||
24
docs/devdocs/03-开发组网站/index.md
Normal file
24
docs/devdocs/03-开发组网站/index.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# 开发组网站
|
||||
就是你所看到的网站;这个网站大概包含了三个部分:
|
||||
|
||||
1. 网维的新wiki
|
||||
|
||||
2. 开发组相关文档
|
||||
|
||||
3. 一个博客系统,可以用来放独立的文章
|
||||
|
||||
|
||||
|
||||
因为感觉没有必要搭建两个基础设施,所以把wiki和开发组文档放在一起,这样也比较方便运维
|
||||
|
||||
网站采用[Docusaurus](https://www.docusaurus.io)框架,详细文档移步官网查看
|
||||
|
||||
**项目地址**:https://github.com/ZSCNetSupportDept/website
|
||||
|
||||
|
||||
## 目录
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList className="docs-card" />
|
||||
|
||||
2
docs/devdocs/03-开发组网站/撰写内容.md
Normal file
2
docs/devdocs/03-开发组网站/撰写内容.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 撰写内容
|
||||
如何向wiki,开发组文档和文章板块添加内容
|
||||
2
docs/devdocs/03-开发组网站/项目构建与部署.md
Normal file
2
docs/devdocs/03-开发组网站/项目构建与部署.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 项目构建与部署
|
||||
如何构建与部署该项目
|
||||
2
docs/devdocs/03-开发组网站/项目配置.md
Normal file
2
docs/devdocs/03-开发组网站/项目配置.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 项目配置
|
||||
如何修改项目的配置(界面,行为等)
|
||||
Reference in New Issue
Block a user