Markdown文档格式规范全解析,轻松排版你的文档
一、基本格式
标题格式 Markdown的标题通过
#来进行分级,一级标题为一个#,二级标题为两个##,以此类推,六级标题为六个####。例如:# 这是一级标题 ## 这是二级标题 ### 这是三级标题段落格式 段落之间至少应空一行。首行通常不缩进,但如果整个文档的首行缩进,则 Markdown 会自动处理。例如: “` 这是一个段落。
这是另一个段落。
3. 列表格式
无序列表以`-`、`+`或`*`开头,有序列表则以数字开头,并紧跟一个英文句点。例如:
- 无序列表项一
- 无序列表项二
- 无序列表项三
有序列表项一
有序列表项二
有序列表项三 “`
引用格式 单行引用在引用内容前加上一个
>,多行引用则使用多个>。例如: “`这是单行引用。
这是多行引用的第一行。
这是多行引用的第二行。
5. 链接格式 行内链接在链接文本后加上括号,并给出链接地址。例如:6. 图片格式 图片同样在描述后使用括号给出地址,可以带标题。例如:
7. 代码格式 行内代码使用反引号` `` 包围,多行代码需要三个反引号,并在代码前后加上对应语言标识。例如: ```python def hello_world(): print("Hello, world!")
二、高级格式
表格格式 表格由竖线
|分隔的行组成,每一行的第一个和最后一个单元格通常表示表头。例如:| 表头1 | 表头2 | 表头3 | | --- | --- | --- | | 内容1 | 内容2 | 内容3 |分隔线 分隔线可以使用三个或更多的短横线
-、星号*或下划线_。例如:”`
- * ____
”`
任务列表 使用方括号和圆括号组合表示未完成的或完成的任务。例如: “`
- [ ] 未完成的任务一
- [x] 已完成的任务一
”`
引用块 引用块使用四个或更多的空格缩进,或一个制表符开头。例如: “` 四个或更多的空格 或者 一个制表符
这是引用块的内容。 “`
三、排版建议
- 保持文档结构清晰,合理使用标题和列表,提升阅读体验。
- 适当添加图片和代码示例,使文档更加直观易懂。
- 尽量使用简洁的格式,避免复杂特殊格式过多,保持文档整洁。
- 考虑在不同文档编辑器或平台间转换时的格式兼容性问题。
