mirror of
https://github.com/ZSCNetSupportDept/website.git
synced 2025-10-28 17:05:03 +08:00
完善网站的文档
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# 开发组网站概览
|
||||
# 开发组网站-概览
|
||||
## 技术
|
||||
网站基于Docusaurus开发,一个静态网页生成的框架,尤其对于生成技术文档来说,它提供了一个美观,现代的前端界面,这个项目本身是一个react.js应用,生成网页时只要输入:`npm run build`便可以在build目录里构建网站的所有资源,以进一步部署,关于详细的配置,可以去看官方的文档:[文档连接](https://www.docusaurus.cn/docs/category/guides)
|
||||
## 工作流程
|
||||
@@ -8,7 +8,6 @@
|
||||
所有的公告文件都储存在blog文件夹下\
|
||||
所有的静态页面都储存在src/pages文件夹下\
|
||||
所有的媒体文件都储存在static文件夹下\
|
||||
系统会根据这些文件,在build里生成网站的所有页面文件,以供我们部署
|
||||
|
||||
docusaurus.config.js是项目的配置文件,配置格式请参照官方文档
|
||||
## 部署
|
||||
@@ -1,22 +0,0 @@
|
||||
# 开发组网站-内容发布
|
||||
**本篇文章将教你如何为开发组网站贡献内容,修改内容,以及内容的维护**
|
||||
## Edit This Page
|
||||
页面最下面有一个Edit This Page的超链接,点击就可以进入github里这个页面的源代码,可以提交PR,有权限的也可以直接修改
|
||||
## 增加内容
|
||||
docusaurus按照一定的文件层次将markdown文档转换成静态页面,在仓库里,docs文件夹下的是网站的文档,blog文件夹下的为公告,src/pages下的为独立页面(如首页),如果要增添新的内容,记得把内容放在正确的地方里
|
||||
### 前缀
|
||||
所有文件都要加入一个数字前缀,用来指示构建系统按照序号生成文章在sidebar中的顺序,按照`order-filename.md`的格式命名
|
||||
|
||||
btw,docusaurus不会将以"_"开头的文件加入完成的网页中,所以可以在暂时不想要展现在最终网站的里的的文章前面加上一个下划线
|
||||
### Markdown 文档
|
||||
Markdown 是一个标记文本格式的语言,轻便简单快捷,markdown最基本的语法如下:[markdown语法](https://commonmark.org/) ,我们用Markdown来编写文档,需要注意的是,文档只能有一个h1,系统用它来产生sidebar条目
|
||||
|
||||
另外docusaurus好像支持mdx格式的文档,可以把一些动态元素插入到文本中,
|
||||
### 媒体资源引用
|
||||
将所有媒体资源放在static目录内,然后在文档中调用
|
||||
|
||||
## 公告
|
||||
docusaurus自带一个blog插件,需要按照`yyyy-mm-dd-filename.md`的格式发布
|
||||
|
||||
## 文档的维护
|
||||
如果发现了文档有错误的地方,请提交PR修改,或者告知开发组成员,
|
||||
40
docs/devdocs/02-网站/03-开发组网站-内容.md
Normal file
40
docs/devdocs/02-网站/03-开发组网站-内容.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# 开发组网站-内容
|
||||
**本篇文章将教你进行内容发布,维护开发组网站内容的方法**
|
||||
## 如何修改
|
||||
### 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目录内,然后在文档中调用
|
||||
|
||||
### 公告
|
||||
docusaurus自带一个blog插件,需要按照`yyyy-mm-dd-filename.md`的格式发布
|
||||
|
||||
## 文档的维护
|
||||
如果发现了文档有错误的地方,请提交PR修改,或者告知开发组成员,
|
||||
|
||||
## 进阶
|
||||
更详细的内容,还是建议看docusaurus的官方文档:[文档连接](https://www.docusaurus.cn/docs/category/guides)
|
||||
2
docs/devdocs/02-网站/03-开发组网站-部署.md
Normal file
2
docs/devdocs/02-网站/03-开发组网站-部署.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 开发组网站-部署
|
||||
本篇文章是开发组网站的部署流程备忘录
|
||||
@@ -1,2 +1,2 @@
|
||||
# 网站外观修改
|
||||
# 开发组网站-外观
|
||||
**本篇指南将教你如何修改开发组网站的外观**
|
||||
2
docs/devdocs/02-网站/06-主页面.md
Normal file
2
docs/devdocs/02-网站/06-主页面.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 主页面
|
||||
主页面就是www.zsxyww.com下的页面,这个页面好像很久没人维护了,文档正在编写。。。
|
||||
Reference in New Issue
Block a user