发表更新Wiki / 技术教程

Markdown写作规范

Markdown 写作规范

一、为什么使用 Markdown

Markdown 适合编写学习笔记、项目文档、技术教程、活动记录、竞赛复盘和 Wiki 页面。

二、标题规范

1
2
3
4
5
# 文档标题

## 一级章节

### 二级章节

三、列表规范

1
2
3
- 内容一
- 内容二
- 内容三

四、代码块规范

1
2
3
```python
print("Hello World")
```

五、表格规范

1
2
3
4
| 字段 | 说明 |
| --- | --- |
| name | 姓名 |
| age | 年龄 |

六、协会 Wiki 写作建议

  1. 标题清晰；
  2. 段落不要过长；
  3. 多使用小标题；
  4. 技术步骤要能复现；
  5. 项目文档要说明背景、目标、功能、技术栈和运行方式；
  6. 竞赛复盘要记录问题和改进，而不只是写成绩。
#
×