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

优化网站文档的结构

This commit is contained in:
2024-08-19 15:14:07 +08:00
parent e94a6d324a
commit 0abee86f13
6 changed files with 0 additions and 0 deletions

View File

@@ -0,0 +1,16 @@
# 开发组网站-概览
## 技术
网站基于Docusaurus开发,一个静态网页生成的框架尤其对于生成技术文档来说它提供了一个美观现代的前端界面这个项目本身是一个react.js应用生成网页时只要输入`npm run build`便可以在build目录里构建网站的所有资源以进一步部署关于详细的配置可以去看官方的文档[文档连接](https://www.docusaurus.cn/docs/category/guides)
## 工作流程
基本上我们需要把markdown文件放在目录里面系统就会根据目录的结构自动生成网页但是我们必须写好配置文件如果我们想自定义网站的外观的话也需要好好研究一下配置文件有关文档还在编写中
## 目录
所有的文档文件都储存在docs文件夹下\
所有的公告文件都储存在blog文件夹下\
所有的静态页面都储存在src/pages文件夹下\
所有的媒体文件都储存在static文件夹下供用户下载的资源也储存在这里\
docusaurus.config.js是项目的配置文件配置格式请参照官方文档
## 部署
目前不确定
## 注意事项
最好还是看官方文档

View File

@@ -0,0 +1,42 @@
# 开发组网站-内容
**本篇文章将教你进行内容发布,维护开发组网站内容的方法**
## 如何修改
### Edit This Page
页面最下面有一个Edit This Page的超链接点击就可以进入github里这个页面的源代码可以提交PR有权限的也可以直接修改
### git clone
(该方法仅限有权限的开发组成员)\
如果你要进行比较多的修改的话,你也可以将仓库拉取到本地,然后修改,新建文件夹,打开终端
- 输入`git clone https://github.com/ZSCNetSupportDept/website.git`
- 输入`git checkout master`
- 此时你应该可以看见项目的源代码,修改你需要改动的内容,然后输入`git add *`
- 输入`git commit`,将你的改动提交到本地
- 输入`git push`,提交内容到仓库
## 仓库的内容
你可以看见三个文件夹分别是src,docs,blog,其中:
- src文件夹存放了独立于文档和blog的静态页面
- docs文件夹存放了所有的文档目前有wiki和开发组文档两个docs
- blog文件夹存放了可以显示在“公告”板块的文章
所有的文档都以Markdown格式书写其实也可以用MDX格式
### 前缀
所有文件都有一个数字前缀,这是文章在成品网站中的顺序,文件请按照`order-filename.md`的格式命名
btw,docusaurus不会将以"_"开头的文件加入完成的网页中,所以可以在暂时不想要展现在最终网站的里的的文章前面加上一个下划线
### 栏目的概况
我们可以在一个子文件夹中加入`index.md`或者`README.md`或者`{$文件夹的名称}.md`,其中的内容会在成品网站中显示为这个栏目的概况(点击这个栏目本身出现的内容)
### Markdown 文档
Markdown 是一个标记文本格式的语言轻便简单快捷markdown最基本的语法如下[markdown语法](https://commonmark.org/) 我们用Markdown来编写文档,需要注意的是文档只能有一个h1系统用它来产生sidebar条目
另外docusaurus好像支持mdx格式的文档可以把一些动态元素插入到文本中
### 媒体资源引用
请将所有媒体资源放在static目录内然后在文档中调用
### 下载
`static`目录下面的内容会直接放到生成的网页里我们在wiki和开发组文档里各设置了一个下载页面提供便捷访问的方式在Markdown文本里链接这些文件来提供下载的方式
### 公告
docusaurus自带一个blog插件需要按照`yyyy-mm-dd-filename.md`的格式发布
## 文档的维护
如果发现了文档有错误的地方请提交PR修改或者告知开发组成员
## 进阶
更详细的内容还是建议看docusaurus的官方文档[文档连接](https://www.docusaurus.cn/docs/category/guides)

View File

@@ -0,0 +1,12 @@
# 开发组网站-部署
本篇文章是开发组网站的部署流程备忘录
## 流程
网站假设在我们的云服务器上服务器会自动从仓库的build分支拉取内容所以网站的部署流程是这样的
1. 将website仓库clone到本地/pull拉取最新版本
2. 运行`npm start`在localhost:3000上运行网站的测试版本
3. 确认网站的最新版本没有问题后,运行`npm run docusaurus deploy`npm会自动构建网页文件推送到origin/build分支上(记得配置好你的ssh,联系组长来获取仓库的权限)
4. 服务器获取build分支的最新版本pull到`/var/www/developer`目录下
5. 服务器采用nginx提供对developer.zsxyww.com的访问
## demo
我在cloudflare pages上部署了一个网站的demo,这个网站会自动基于master分支构建而不是获取构建好的build分支可以在上面预览网站的效果觉得没问题了再进行build,网址https://zscdev-demo.pages.dev/

View File

@@ -0,0 +1,2 @@
# 开发组网站-外观
**本篇指南将教你如何修改开发组网站的外观**