Markdown是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面。以下是一份详细的Markdown文档格式规范指南,帮助您更好地使用Markdown进行文档编写。
1. 基本格式
1.1 标题
Markdown支持6级标题,使用#进行标记,其中#的数量表示标题的级别。例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
1.2 段落
段落由至少一个空行分隔。在段落开头或结尾添加两个空格可以提高可读性。
1.3 强调
斜体:使用一个*包裹文本实现斜体效果。
粗体:使用两个*包裹文本实现粗体效果。
粗斜体:使用三个*包裹文本实现粗斜体效果。
1.4 列表
无序列表:使用
-、*或+开头。- 无序列表项1
- 无序列表项2
- 无序列表项3
有序列表:使用数字和英文句点开头。
- 有序列表项1
- 有序列表项2
- 有序列表项3
1.5 链接
1.6 图片
1.7 代码块
# Python 代码示例
def hello_world():
print("Hello, world!")
2. 高级格式
2.1 表格
| 表头1 | 表头2 | 表头3 |
|---|---|---|
| 内容1 | 内容2 | 内容3 |
| 内容4 | 内容5 | 内容6 |
2.2 引用
引用文本
2.3 分隔线
或
3. 语法扩展
3.1 任务列表
- [x] 完成任务1
- [ ] 进行中任务2
- [ ] 未开始任务3
3.2 定义列表
- 定义1:这是一个定义
- 子定义1:这是一个子定义
- 定义2:这是另一个定义
- 子定义2:这是一个子定义
4. 注意事项
- 使用空格和缩进来表示代码块的层级,而非制表符。
- 使用四个空格或一个制表符作为代码块的缩进。
- 链接和图片地址应使用绝对路径或相对路径。
- 尽量避免在链接和图片地址中使用空格。
希望这份Markdown文档格式规范指南能帮助您更好地使用Markdown进行文档编写。
