MarkDown使用小技巧


写作目的

在看了一些MarkDown的入门语法之后,发现许多的文档对一些比较细微的问题缺乏解释。所以打算再进行补充一下。

目标读者

使用MarkDown仅仅为了排版出更好看的文章,而不关注技术细节,不懂HTML的用户。


1、首行缩进

写文章时,我们常常希望能够首行缩进,这时可以在段首加入 来输入一个空格.加入 来输入两个空格。

示例

文本

1
  一语未了,只听后院中有人笑声,说:“我来迟了,不曾迎接远客!"

效果

  一语未了,只听后院中有人笑声,说:“我来迟了,不曾迎接远客!

2、插入代码

插入代码的方式有两种

  1. 在每行代码前加入4个空格或者添加一个制表符(TAB键)
  2. 在代码两侧添加三个反引号‘```’。

两种方法都有需要注意的地方,很多入门文档未能提及。

2.1 方式1

其缩进是相对于当前格式状态下的。

示例

文本

  • 列表项
  • 列表项
    [TAB][TAB]printf(“hello world!”);

效果

  • 列表项
  • 列表项
    printf("hello world!");
    

在列表项状态下,需要输入两次TAB键(制表符)才能以代码格式插入(本主题下的代码颜色显示有点怪异)。

2.2 方式2

反引号最好在代码的前后行添加,而不是直接加在代码两边。

示例

文本

```
var sta = “swift你好,我叫akaziki”
println(sta)
```

效果

1
2
var sta = "swift你好,我叫akaziki"
println(sta)

3、添加空行

添加空行可以结束先前的格式状态。个人建议在改变格式时,均添加一个空行。

示例

文本

>引用状态
[空行]
###标题状态
[空行]
------
[空行]
- 列表状态
- 列表状态

效果

引用状态

标题状态


  • 列表状态
  • 列表状态

4、其他

  • 普通段落尽量不用空格或制表符来缩进,即使使用它们后得到的效果看似是对的。

  • [数字] + ‘.’ + [空格] 的形式会呼出有序的项目列表。因此如果你在正文中恰好出现这种形式,那么可以在‘.’的前面加上‘\’来避免出现有序列表。

2017-10-02

谢谢你请我吃糖果