Markdown 使用教程

Markdown简介

wiki释义:

Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)和亚伦·斯沃茨(Aaron Swartz)。
它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。
这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

Markdown的优点包括但不限于以下几点:

  • 纯文本,所以兼容性极强,可以用所有文本编辑器打开。
  • 让你专注于文字而不是排版。
  • 格式转换方便,Markdown 的文本你可以轻松转换为 html、电子书等。
  • Markdown 的标记语法有极好的可读性。

Markdown语法

Markdown语法简洁明了、容易学习,下面一一介绍。

基本符号

  • *, - , +: 这3个符号的效果都一样, 被称为Markdown符号
  • 空白行 : 表示另起一个段落,对应HTML中的 <p> 元素
  • ` 表示 内联代码tab是用来标记代码段,分别对应HTML的 <code><pre> 元素

段落换行

  • 单个回车会被解释为空格
  • 一个空白行(即两个回车)变成单一段落<p>
  • 连续3个Markdown符号,然后回车,表示<hr>横线
  • 连续多个空格会被解释为单个空格

标题

  • 在文字前面加上1-6个#来实现, 代表HTML中的六级标题 h1-h6
  • 在文字左右各加1-3各符号,可本别实现斜体<i>、加粗<b>和斜体加粗

    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 六级标题
    
    *斜体*
    
    **加粗**
    
    ***加粗斜体***

引用

  • 在第一行加上 > 和一个空格,表示引用,还可以嵌套, 对应HTML中的<blockquote>标签

列表

  • 使用*,+,-加上一个空格来表示,对应HTML中的<ul>标签
  • 可以支持嵌套
  • 有序列表用 数字+.+空格 来表示,对应HTML中的<ol>标签
  • 如果列表内容很长,不需要手工输入换行符,css控制段落的宽度,会自动的缩放的

    **无序列表:**
    
    - 无序列表 1
    - 无序列表 2
    - 无序列表 3
    
    **有序列表:**
    
    1. 有序列表 1
    2. 有序列表 2
    3. 有序列表 3
    
    **列表嵌套:**
    
    - One
        + What
        + Why
        + How
    - Two
    - Three

效果如下

无序列表:

  • 无序列表 1
  • 无序列表 2
  • 无序列表 3

有序列表:

  1. 有序列表 1
  2. 有序列表 2
  3. 有序列表 3

列表嵌套:

  • One
    • What
    • Why
    • How
  • Two
  • Three

链接

在 Markdown 中,插入链接只需要使用 [显示文本](连接地址)这种格式,
插入图片只需要使用![图片描述](图片链接地址)这种格式即可,其中前者对应于
HTML中的a标签,后者对应img标签,方括号中的图片描述为img标签的的alt属性值

还有一种建立链接的方式,称为参考式, 参考式的链接是在链接文字的括号后面再接上另一个方括号, 而在第二个方括号里面要填入用以辨识链接的标记: [显示文本][id]![图片描述][id]. 接着,在文件的任意处,你可以把这个标记的链接内容定义出来:[id]: http://example.com/

示例:

个人信息:

[Wentong](http://www.fangwentong.com/)

- [GitHub][1]
- [Facebook][]
- [Twitter][Weblog]

[1]: https://github.com/fangwentong/
[Facebook]: https://facebook.com/fangwentong/
[Weblog]: https://twitter.com/fangwentong/

效果如下:

个人信息:

Wentong

表格

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

特殊符号

  • \ 来转义,表示文本中的markdown符号

兼容HTML语法

我们知道,Markdown最终要通过Markdown解释器转换为HTML文档, 而Markdown是一种书写的格式,它的语法种类很少,只对应HTML标记中的一小部分, 不在Markdown涵盖范围内的标签, 可以直接在文档中用HTML书写.

自定义Markdown样式

注意到,Markdown解释器将Markdown文本转换为HTML文档,我们编写CSS,并在生成的HTML文档中引用这个样式表, 可以达到自定义Markdown显示风格的效果.

几个好用的Markdown工具

参考文章:

  1. 官方文档(中文版):Markdown 语法说明
  2. 鲁塔弗:markdown 简明语法
  3. 简书:献给写作者的 Markdown 新手指南