Skip to content

Commit

Permalink
chore: add contribute guide (#38)
Browse files Browse the repository at this point in the history
* chore: rename old documents and fix some invalid syntax

* chore: update image url

* chore: add contribute guide

* update: add insert image hint

* Update contribute-guide.md

* Update contribute-guide.md

---------

Co-authored-by: ozline <[email protected]>
  • Loading branch information
CubeSugarCheese and ozline authored Mar 7, 2024
1 parent 05c81dc commit 0475a62
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
## 如何分享自己的经验

- 对于没有 Git 使用背景的大部分同学,可以把自己的经验文稿发送给:[email protected] ,我们会帮助你发布
- 对于有 Git 背景的同学来说,请对 `docs`下的对应文件夹 Pull Request,我们会及时的 Review、Merge。
- 对于有 Git 背景的同学来说,请参阅 [贡献指南](https://run.w2fzu.com/contribute-guide/) ,我们会及时的 Review、Merge。

## 支持

Expand Down
66 changes: 66 additions & 0 deletions docs/contribute-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# 贡献指南

## 转专业文章
### 编写规范
我们没有强制规范,你可以参照其他人所写的文章

### 上传规范

将你编写的 markdown 文件放置于 `/docs/change-major/{转入学科}`

如果你没有找到对应学科的目录,也可以自行创建

文档的命名遵循以下规则:

{年份}{月份}{日期}-{编号}.md

其中年份取低两位(我们认为文档是不会一直到 2100 年还在使用的)
月份和日期不到两位的,在高位上补0
编号按照同一日内的文章上传顺序依次顺延

放置好 markdown 文件后,你需要修改 `mkdocs.yml` 来让别人可以看到你的文章

`nav > 转专业 > {转入学科}` 下添加你的文章
名字遵循以下规则:
`[{年级}]{转专业年份}-{原专业}->{现专业}`
同样的,如果你没有找到对应学科,也可以自行增加

**注意:请不要使用一级标题(#),第一级标题从二级标题(##)开始**

## 研究生文章
### 编写规范
同样不设定强制规范,请随意决定文章的格式

### 上传规范
与转专业文章大体相同

markdown 文件放置在 `/docs/postgraduate/{学校}`

`.md` 文件命名规范与转专业文章相同

`nav > 研究生 > {学校}` 下添加你的文章

名字遵循以下规则:
`[考研/保研] {年级}-{学院/专业方向}`

## 添加图片
如果你想在文章中添加图片,可以自行选择图床并在文章中插入链接

或者也可以联系我们,我们会将你的图片上传至我们的图床后提供对应的链接

## 预览文章
此项是非必需的,但是我们**强烈建议**你在上传文件前进行预览,以便确认文章的展示效果。

本项目采用 [Mkdocs](https://www.mkdocs.org/) 及其对应主题 [Mkdocs-Material](https://squidfunk.github.io/mkdocs-material/),您可以自行参考官网或第三方教程安装,我们这里也提供 python 安装方式

你需要先安装 `python`

随后运行以下命令
```
pip install mkdocs
pip install mkdocs-material
```
如果你发现安装极为缓慢甚至安装失败,请参阅 [PyPI 镜像使用帮助](https://mirrors.tuna.tsinghua.edu.cn/help/pypi/)

安装完成后,在项目目录下运行 `mkdocs serve`
访问 http://127.0.0.1:8000 即可预览你的文章
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ site_url: https://run.w2fzu.com/
site_author: west2-online
site_description: '福州大学转专业经验手册'
nav:
- 首页: index.md
- 首页:
- index.md
- 贡献指南: contribute-guide.md
- 关于: about.md
- 转专业:
- change-major/README.md
Expand Down

0 comments on commit 0475a62

Please sign in to comment.