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

更新开发组文档,完善wiki的错误码板块,优化了结构

This commit is contained in:
2025-06-21 15:30:30 +08:00
parent 91b2352507
commit 92ae4a93d0
30 changed files with 171 additions and 32 deletions

View 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`下文档时出现在左边的栏目)配置文件