Markdown语法教程

本文将简单介绍Markdown语法,这对撰写文档很有帮助。

Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全采用Markdown编辑器的博客平台有Ghost和Typecho。

最常见的是用于编写说明文档,并且以“README.md”的文件名保存在软件的目录下面(在GitHub经常能见到)。

除此之外,由于我们有了RStudio这样的神级编辑器,我们还可以快速将Markdown转化为演讲PPT、Word产品文档、LaTex论文甚至是用非常少量的代码完成最小可用原型。在数据科学领域,Markdown已经广泛使用,极大地推进了动态可重复性研究的历史进程。

总的来说,你可以把Markdown看作是“另一种LaTeX”,非所见即所得的文档编写语言。


开始之前

值得注意的一些地方:和LaTeX一样,无论你两个字之间空了多少格、无论两段之间敲了多少个回车,最终的文本里两个字之间只会有一个空格、两段之间只有一次换行。用很多符号都是有用的,如果你需要在文章中展现被Markdown另做它用的符号,例如被用作标记“标题”的#号,请在符号前加入\号。例如这样写:\#

标题

标题能显示出文章的结构。行首插入1-6个 # 并且空格,每增加一个 # 表示更深入层次的内容,对应到标题的深度由 1-6 阶。

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

效果:

Header 1

Header 2

Header 3

Header 4

Header 5
Header 6

文本样式

(带“*”星号的文本样式,在原版Markdown标准中不存在,但在其大部分衍生标准中被添加)

链接 :[Title](URL)
加粗 :**加粗**
斜体 :*斜体*
高亮 :==高亮==
删除线:~~删除线~~
下划线:<u>下划线</u>
段落 : 段落之间空一行
换行符 : 一行结束时输入两个空格,跟段落效果是一样的。
列表 :* 添加星号成为一个新的列表项,或者使用数字加点:1.
引用 :> 引用内容,多敲几个进行嵌套
内嵌代码 : `代码内容`
代码块:使用两组```将代码括起来,注意它们分别独占一行
画分割线 (HR) :三个以上的-或者*
方框:- [ ] -

效果:
链接:这是一个跳转到博客主页的链接
加粗:加粗
斜体:斜体
高亮:高亮
删除线:删除线
下划线:下划线
段落:这篇文章本身就有很多段落。
换行符:我使用的编辑器不支持,无法演示。
列表:

  • 这是一个列表
  • 列表的第二行
    • 最前面空两格进行列表嵌套
    • 第二行列表嵌套
  • 跳出列表嵌套
  1. 数字列表
  2. 数字列表第二行
    1. 最前面空三格进行嵌套
    2. 第二行列表嵌套
  3. 跳出嵌套

引用:

鲁迅曾经说过

鲁迅说他没说过

内嵌代码:void function(int a){return 0;}
代码块:

#include<stdio.h>

int main(void){
    return 0;
}

方框:我的编辑器不支持。如果有冲突,用\[这种方法也是可以的。


图片

图片名将会显示在图片底下,而图片地址可以是本地的地址,也可以是网络地址,可以是相对地址,也可以是绝对地址。这取决于你所使用的Markdown编辑器的兼容性。最后一个括号和它的内容是可选的,如果写上,就可以使得点击图片的时候跳转到别的地方。

![图片名](图片地址) (超链接)

脚注

脚注不存在于标准Markdown中。
使用这样的占位符号可以将脚注添加到文本中:[^1]. 另外,你可以使用任意字符串例如“hello”而不是数字。所以你不必纠结号码的顺序。

这里是脚注[^1]
[^1]:这里是示例脚注1号的内容
 
这里是脚注[^hello]
[^hello]:这里是示例脚注2号的内容

效果:
这里是脚注[1]

这里是脚注[2]


其它

Markdown还有更多语法以实现更多功能,例如表格、HTML元素、控制流(思维导图)等等,详细情况请参阅外部教程


知识共享许可协议
本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。


  1. 这里是示例脚注1号的内容 ↩︎

  2. 这里是示例脚注2号的内容 ↩︎

Creative Commons License