一、前言
对于一个优秀的开发者而言,Markdown工具是必不可少的。常用于写需求文档、示例文档、接口文档、运行流程、bug追踪记录、README帮助文档等文档中,这些文档可以以编写Markdown文件的方式快速呈现效果。本教程将借用Pycharm中的Markdown插件来讲解Markdown的语法。
二、基础语法
- 标题
标题在文字前用“#”加一个空格进行标记,每级标题加多一个“#”。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
- 列表
无序列表在文字前用“-”或者“*”加一个空格进行标记,有序列表在文字前用数字加"."加一个空格进行标记。
- a
- b
- c
* d
* e
* f
1. 一
2. 二
3. 三
- 引用文字
引用文字需要在文字前加一个“>”(大于号)进行标记,结束引用需要用空行。
飞雪连天射白鹿
笑书神侠倚碧鸳
红尘有你终相伴
笑傲江湖情两牵
- 图片与链接
插入链接与插入图片的语法很像,区别在一个“!”号。
链接是显示的文字,图片是[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-P4MPT4uD-1645165907983)(图片链接)]
[我的id是技术空间(code_space)](https://www.toutiao.com/c/user/token/MS4wLjABAAAAhJ6X9RgjGeGLqCUaQOWNZdvoynU3RsGglpFsnICJAlE/?source=tuwen_detail&log_from=4ad2cb18d5576_1644563410549)
![我的id是技术空间:code_space](https://sf1-cdn-tos.toutiaostatic.com/img/user-avatar/412661ae4ca495f242968dd4fe3528e7~300x300.image)
- 粗体与斜体
用两个“”包含一段文本就是粗体的语法,用一个“”包含一段文本就是斜体的语法。
*我是技术空间*
**我是技术空间**
- 代码引用
需要引用代码时,如果引用的代码只有一行,可以用“`”将代码包起来。
如果引用的代码为多行,可以将“```”置于这段代码的首行和末行。
print("Hello ! I'm code_space")
print("Hello ! I'm code_space")
print("你好 ! 我是技术空间")
print("这是我的技术笔记")
三、拓展
下篇Markdown文章我将会把高级应用的语法笔记整理出来。欢迎持续关注。