MarkDown语法小结|青训营笔记

99 阅读3分钟

这是我参与「第四届青训营 」笔记创作活动的第9天。

对于程序员来说,该怎么记笔记呢?大家都知道,程序员平时很忙,有没有一种方法可以节省他们的的时间呢?毫无疑问,MarkDown便是他们很好的选择。

什么是MarkDown

简单来说,Markdown是一种轻量级标记语言,如同笔者现在记录的形式,它以纯文本形式(易读、易写、易更改)编写文档,并最终以HTML格式发布。Markdown也可以理解为将以MARKDOWN语法编写的语言转换成HTML内容的工具。

为什么要使用

  • 易读(看起来舒服)、易写(语法简单)、易更改纯文本。处处体现着极简主义的影子,适合程序员。
  • 兼容HTML,可以转换为HTML格式发布。
  • 跨平台使用。
  • 越来越多的网站支持Markdown。
  • 更方便清晰地组织你的电子邮件。(Markdown-here, Airmail)
  • 摆脱Word。

MarkDown语法

Markdown语法主要分为如下几大部分:

  • 标题
  • 段落
  • 区块引用
  • 代码区块
  • 强调
  • 列表
  • 分割线
  • 链接
  • 图片
  • 反斜杠 \
  • 符号'`'

标题

第一种写法
使用=-标记一级和二级标题。

一级标题
=========
二级标题
---------

效果如下:(注意:在不同浏览器中或者同一浏览器不同主题以下可能显示效果不同)

一级标题

二级标题

第二种写法
使用#,可表示1-6级标题。

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

段落

段落的前后要有空行,所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用两个以上空格加上回车(引用中换行省略回车)。

区块引用

在段落的每行或者只在第一行使用符号>,还可使用多个嵌套引用,如:

> 区块引用
>> 嵌套引用

效果

区块引用

嵌套引用

代码区块

代码区块的建立是在每行加上4个空格或者一个制表符(如同写代码一样)。
普通段落
void main()
{
printf("Hello, Markdown.");
}

代码区块

void main()
{
    printf("Hello, Markdown.");
}

注意:需要和普通段落之间存在空行。

同时还有一种更为普遍的用法:用六个`包裹多行代码,如

```
void main()
{
printf("Hello, Markdown.");
}
```

效果如下

void main()    
{    
    printf("Hello, Markdown.");    
} 

小贴士:可以在第一行```后加上代码语言,浏览器会根据相应语言进行渲染。

强调

在强调内容两侧分别加上*或者_,如:

*斜体*,_斜体_
**粗体**,__粗体__

效果:

斜体斜体
粗体粗体

列表

使用·+、或-标记无序列表,如:

-(+*) 第一项 -(+*) 第二项 - (+*)第三项

注意:标记后面最少有一个_空格_或_制表符_。若不在引用区块中,必须和前方段落之间存在空行。

效果:

  • 第一项
  • 第二项
  • 第三项

有序列表的标记方式是将上述的符号换成数字,并辅以.,如:

1 . 第一项
2 . 第二项
3 . 第三项

效果:

  1. 第一项
  2. 第二项
  3. 第三项

分割线

分割线最常使用就是三个或以上*,还可以使用-_

效果如下:


链接

链接可以由两种形式生成:行内式参考式
行内式

[网址文字描述](url)。

效果:

掘金

参考式

[网址文字描述1][1]
[网址文字描述2][2]
[1]:juejin.cn
[2]:juejin.cn

效果:

掘金官方网址1
掘金官方网地2

图片

添加图片的形式和链接相似,只需在链接的基础上前方加一个

反斜杠\

相当于反转义作用。使符号成为普通符号。

符号'`'

起到标记作用,如:

`ctrl+a`

效果:

ctrl+a

总结

通过上述的学习,有没有发现MarkDown语法的简洁性,也正是因为它的简洁性,获得了大多数程序员的喜爱。