mirror of
https://github.com/ZSCNetSupportDept/website.git
synced 2025-10-31 10:26:20 +08:00
44 lines
2.7 KiB
Markdown
44 lines
2.7 KiB
Markdown
# 开发组网站-内容
|
||
**本篇文章将教你进行内容发布，维护开发组网站内容的方法**
|
||
## 如何修改
|
||
### 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)
|