MarkDown基础教程

涵盖基本的MarkDown语法

Posted by LY on June 1, 2019

因为写博客主要是用到MarkDown进行编辑,所以本次博客就给大家总结下一些MarkDown的常用语法。很简单,5分钟看完就可以学会,这些基础语法基本可以满足我们写一篇文章的要求了。

遗憾的是,MarkDown不支持设置文字颜色,仅支持文本编辑,有色彩需求的亲们,可以将md文件转换成html文件后再行操作。

我是先参考了两篇简书教程进行学习后,再写下这篇文章,以下例行感谢: 教程1 教程2

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。

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

用于编写说明文档,并且以”README.MD”的文件名保存在软件的目录下面。

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

本文主要给大家介绍下使用MarkDown写博客的一些常用语法。

基础语法

标题

在想要设置为标题的文字前面加#来表示。一个#是一级标题,二个#是二级标题,以此类推。支持六级标题

注:标准语法一般在#后跟个空格再写文字。

示例:


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

效果如下:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

字体

  • 斜体

    要倾斜的文字左右分别用一个*号包起来

  • 加粗

    要加粗的文字左右分别用两个*号包起来

  • 斜体加粗

    要倾斜和加粗的文字左右分别用三个*号包起来

  • 删除线

    要加删除线的文字左右分别用两个~~号包起来

示例:

*这是倾斜的文字* 
**这是加粗的文字**
***这是斜体加粗的文字***
~~这是加删除线的文字~~

效果如下:

这是倾斜的文字 这是加粗的文字 这是倾斜加粗的文字 这是加删除线的文字

段落及区块引用

需要记住的是,Markdown其实就是一种易于编写的普通文本,只不过加入了部分渲染文本的标签而已。其最终依然会转换为html标签,因此使用Markdown分段非常简单,前后至少保留一个空行即可。

而另外一个比较常见的需求就是,我们可能希望对某段文字进行强调处理。Markdown提供了一个特殊符号>用于段首进行强调,被强调的文字部分将会高亮显示。

示例:


>引用的内容将被高亮显示

效果如下:

引用的内容将被高亮显示

分割线

有的时候我们为了排版漂亮需要使用分割线。三个或三个以上的 - 或 * 都可以

示例:


***
---
*****
-----

效果显示出来都是一样的,如下:





插入图片

插入图片的语法如下:

第一种是使用外地地址的图片


![图片alt](图片地址 "图片title")

图片alt就是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。
图片alt和图片title都可加可不加

第二种是使用我们github pages里面自带的图片

图片已经提前被我们放入在 _img 文件夹


![](/img/图片名称.jpg)

如果是其他格式的图片,文件名后缀改一下。

超链接

MarkDown中插入链接的语法如下:


[超链接名](超链接地址"超链接title")
title可加可不加

示例:


[百度](http://baidu.com)

效果如下:

百度

列表

无序列表和有序列表

Markdown支持有序列表和无序列表两种形式:

  • 无序列表使用*或+或-标识
  • 有序列表使用数字加.标识,例如:1.

示例:


* 张三
* 李四
* 王五

+ 张三
+ 李四
+ 王五

- 张三
- 李四
- 王五

1. 张三
2. 李四
3. 王五

效果如下:

  • 张三
  • 李四
  • 王五

  • 张三
  • 李四
  • 王五

  • 张三
  • 李四
  • 王五
  1. 张三
  2. 李四
  3. 王五

注:这里比较有趣的地方是,对于有序列表,Markdown将只关注你的第一个项目的数字编号。例如:如果第一个项目编号是3,以此类推,第二个项目应该是4,最终将显示为3、4、5。而如果你指定了第一个编号,后面的编号指定错误也没有关系,Markdown将只在乎你的第一个项目编号。

列表嵌套

上一级和下一级之间敲三个空格即可

示例:

  • 一级无序列表内容
    • 二级无序列表内容
    • 二级无序列表内容
    • 二级无序列表内容
  • 一级无序列表内容
    1. 二级无序列表内容
    2. 二级无序列表内容
    3. 二级无序列表内容
  1. 一级有序列表内容
    • 二级无序列表内容
    • 二级无序列表内容
    • 二级无序列表内容
  2. 一级有序列表内容
    1. 二级有序列表内容
    2. 二级有序列表内容
    3. 二级有序列表内容

高级用法

插入代码块

单行代码:代码之间分别用一个反引号包起来

注:很多人不知道怎么输入反引号。在英文模式下,找到键盘最左侧esc键下面的第一个键点击即可。


`代码内容`

`var x=3`

显示出来是 var x=3

代码块:代码之间分别用三个反引号包起来,且两边的反引号单独占一行

(```)
fun (x: int, y: int) :
int {
      return x+y;
    }
(```)

注:为了防止转译,前后两处三个反引号处加了小括号,实际是没有的。这里只是用来演示,实际使用的时候要去掉两边小括号。

显示出来是:


fun (x: int, y: int) :
int {
      return x+y;
    }

表格

表格是Markdown语法中比较复杂的一个,其语法如下:


表头|条目1|条目2
:---|:---:|---:
项目|项目1|项目2

效果如下:

表头 条目1 条目2
项目 项目1 项目2

注:三个短斜杠左右的冒号用于控制对齐方式。只放置左边冒号或不加冒号表示文字居左,因为文字默认是居左,只放置右边冒号表示文字居右,如果两边都放置冒号表示文字居中。

特殊符号处理

Markdown使用反斜杠\插入语法中用到的特殊符号。在Markdown中,主要有以下几种特殊符号需要处理:


\ 反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井号
+ 加号
- 减号
. 英文句点
! 惊叹号

例如,如果你需要插入反斜杠,就连续输入两个反斜杠即可:\\

注:在内容中输入以上特殊符号的时候一定要注意转义,否则将导致内容显示不全,甚至排版混乱。

结语

到这里MarkDown基本语法就介绍完了,是不是真的很简单呢,赶紧用MarkDown把博客写起来…