mirror of
https://github.com/ZSCNetSupportDept/website.git
synced 2025-10-28 17:05:03 +08:00
23 lines
1.6 KiB
Markdown
23 lines
1.6 KiB
Markdown
# 开发组网站-内容发布
|
||
**本篇文章将教你如何为开发组网站贡献内容，修改内容，以及内容的维护**
|
||
## 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修改，或者告知开发组成员，
|