MarkDown语法与使用指南

  Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。目前世界上绝大多数流行的博客平台都能很好的支持Markdown。

  除此之外,我们还可以通过一些功能强大的编辑器快速将Markdown转化为演讲PPT、Word产品文档、LaTex论文甚至是用非常少量的代码完成最小可用原型。在数据科学领域,Markdown已经被确立为科学研究规范,极大地推进了动态可重复性研究的历史进程。

MarkDown语法

基本语法

  1. 标题(Title)

    A. 通过在文字下方(换行)输入 =-,以使用一级标题或二级标题。

    B. 在文字前面加上 #,通过“#”数量来表示标题级别。

    p.s. 有1~6级标题,其中1级标题字体最大。

  2. 块注释(Blockquote)

    通过在文字开头添加 > 表示块注释。

    p.s. 当>和文字之间有五个blank时,块注释的文字会发生变化。

  3. 粗体(Bold)

    使用2个 * 或者 _ 将相应的文字包裹起来即可。

  4. 斜体(Italics)

    使用1个 * 或者 _ 将相应的文字包裹起来即可。

  5. 有序列表(ol)

    使用数字加英文句号再加上空格来表示序号,如 1. + space

  6. 无序列表(ul)

    在文字开头添加(*, +, and -)以实现无序列表。但需要注意的是,(*, +, and -)和文字之间也需要添加空格。
    (建议:一个文档中只是用一种无序列表的表示方式)

  7. 嵌套列表(el)

    可在列表li文字前选择输入 -+* ,并在后面加上 space 来表示。

    其中, - 为列表父li ; + 为列表子li ; * 则为列表通用li。

    -+* 可循环使用,但符号之后的空格不能少,符号之前的空格也不能少。

    e.g. :

    1
    2
    3
    4
    5
    6
    - 嵌套列表1
    + 嵌套列表2
    + 嵌套列表3
    - 嵌套列表4
    * 嵌套列表5
    - 嵌套列表6
    • 嵌套列表1
      • 嵌套列表2
      • 嵌套列表3
      • 嵌套列表4
      • 嵌套列表5
    • 嵌套列表6

  8. 链接(Links)

    Markdown中有两种方式实现链接,分别为内联方式和引用方式。

    内联方式:This is an example link.

    引用方式:I get 10 times more traffic from Google than from Yahoo or MSN.

    格式分别为:

    内联: [ + 链接显示标题 + ] + ( + URL + )

    引用: [ + 链接显示标题 + ] + [ + n(序号)+] +(一些文字 ...)

        (建议写在文章末尾:) [1] + : + URL + space + " + 标题 + "

        (此处省略n条引用记录...)

        (第n条引用:) [n] + : + URL + space + " + 标题 + "

  9. 图片(Image)

    图片的引用方式和链接的相似。

    内联方式: ![alt text](/path/to/img.jpg "Title")

    引用方式: ![alt text][id]

          [id]: /path/to/img.jpg "Title"

  10. 代码(Code)

    A. 简单文字需要一个代码框。使用<blockquote>,即反引号( ` );

    B. 一大段代码需要标记,则可以将代码用3个反引号包裹起来。如果要包裹多个反引号,
     则可用与包裹数不同的反引号进行包裹,注意内容与包裹标记之间以空格分割;

    C. 大片文字需要实现代码框,可使用Tab和四个空格。

  11. 脚注(footnote)

    e.g.:Test About

    实现方式: 脚注标题+[+脚注标题+]

          (另起一行:) [+脚注标题+]+: +脚注内容

常用语法

  1. 分割线(Split)

    另起一行,输入三个或以上的 * -_ 来建立一条分隔线。其中,- 后需要加空格,其它可加或不加。

  2. 表格(Table)

    单元格的格式:以 | 分割左右内容作为表格的单元格。
    表格数据对齐:在插入表格数据的前一行的空白单元格内使用 :- :-: -: 来分别定义左对齐、居中、右对齐的对齐方式。

    1
    2
    3
    4
    5
    |   设备   |   价格   | 数量 |
    | :- | :-: | -: |
    | Surface | ¥6000 | 1 |
    | SmartPhone | ¥5000 | 2 |
    | PC | ¥8000 | 3 |

    设备价格数量
    Surface¥60001
    SmartPhone¥50002
    PC¥80003

  3. 删除线(Line-through)

    在文字内容前后输入2个 ~ 即可。

  4. 缩进(Indent)

    A. 半角大的空白:输入 &ensp;&#8194;

    B. 全角大的空白:输入 &emsp;&#8195;

    C. 不间断的空白:输入 &nbsp;&#160;

  5. 字体、字号、颜色

    将需要套用格式的文字用 <font> </font> 包裹,并在标签内添加相应的属性:

    face color size 分别代表字体、颜色和字号,根据需要可以自己设置对应的值。

    e.g.: <font face="微软雅黑" color=red size=5>栗子</font>   outcome: 栗子

  6. 其他标记

    A. 换行:在内容后面插入<br/>即可;

    B. 下划线:将内容以 <u> </u> 包裹即可。

    详细语法请参考查阅:MarkDown语法手册 - 梵居闹市 & MarkDown Syntax

使用指南

  1. 一般情况建议使用tab进行缩进排版,次要情况才选择上述的缩进符号。

  2. 代码用代码片标记进行包裹,才有语法高亮。您也可以使用<font color= > </font> 的标记对文字进行颜色标记,增加可读性。

  3. 请别忘记对特殊符号进行转义,如反引号 ` ,一个或多个的用法需留意。

  4. 有关数学公式、流程图等的应用需多多查阅博客或问答,掌握使用技巧。

文章作者: Geolage Wu
文章链接: https://geolage.github.io/blog/2017/09/26/MarkDown语法与使用指南/
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处!