docs: CONTRIBUTING

This commit is contained in:
camera-2018
2023-05-04 00:29:23 +08:00
parent 7c5c38c51f
commit 8d957c3568

View File

@@ -21,7 +21,7 @@
- 在各种媒体、博客文章、群内宣传 HDU-CS-WIKI
## 文档风格
1. 使用 Markdown 编写文档,文档格式参考 [Markdown 语法]()
1. 使用 Markdown 编写文档,文档格式参考 Markdown 语法。
2. 一个页面只有一个1级标题H1一个#其他标题从2级开始H2##)。
3. 英文与中文之间用空格分开。
```markdown
@@ -30,6 +30,12 @@
4. 标题内的英文单词首字母大写。
5. 代码块使用 ` ``` ` 包裹,并标注常见的语言标识符,如 ` ```python `
::: tip 🤓 注意
尽量不要使用 `typora` 因为它的渲染效果和本项目前端框架 `vitepress` 不一致。
`typora` 中编辑完成后,确认一下 .md 文件源代码是否为正常 Markdown 。
编辑完成后尽量启动本项目在前端查看效果。
:::
## 项目构建指南