markdown 学习笔记

Markdown 是一种纯文本格式的标记语言，通过简单的标记语法，可以使普通文本内容具有一定的格式。优点主要有：纯文本编辑，操作简单，支持内嵌 html 等。Markdown 语法的学习非常简单，认真学十分钟不到就能学完。

参考简书：Markdown基本语法。

跳转到的地方。未看完全文请忽略这个:)

标题

单个 # 为一级标题，多个类似，示例：

1
2
### 三级标题
#### 四级标题

效果：

三级标题

四级标题

字体

四种字体效果，加粗，斜体，粗斜体，下删除，通过首尾添加符号来实现：

* 这是倾斜的文字 *

** 这是加粗的文字 **

*** 这是斜体加粗的文字 ***

~~ 这是加删除线的文字 ~~

引用

引用可以对文本产生高亮的效果，示例：

1
2
3
> 一级引用
>> 二级引用
>>> 三级引用

显示效果：

一级引用

二级引用

三级引用

注：可添加多个 > ，依次向右缩进。

分割线

使用三个或者三个以上的 - ，前后用空行隔开，示例：

1
2
3

---

本页面剪刀分割线，背后代码都是 ---，如下

图片

添加图片的基本语法：

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

其中：

  • 方括号 [] 为图片读取错误时，显示的文字，可省略。
  • 引号内部，图片title 是图片的标题，即当鼠标移到图片上时显示的内容，可省略。

示例：

1
![图片](/picture/top_img.jpg "小黑")

效果如下：

图片

注1（来自简书）：markdown格式追求的是简单、多平台统一。那么图片的存储就是一个问题，需要用图床，提供统一的外链，这样就不用在不同的平台去处理图片的问题了。才能做到书写一次，各处使用。参考另一篇博客 PicGo 搭建图床 。
注2：由于支持 html 语法，图片也可以用 html 的<img> 标签输入。
注3：设置图片大小的几种方法：知乎。

超链接

超链接，简单来说就是点击后，会跳转到其他位置或页面的特殊文字。语法如下，其中引号为超链接的标题，可省略

1
[超链接名](超链接地址 "超链接title")

注：超链接可以实现文章内的跳转，例如点这里 跳回开头（参考文章两种方式实现页内跳转。）

列表

无序列表

无序列表用 - + * 任何一种都可以，示例：

1
2
3
- 列表内容
+ 列表内容
* 列表内容

效果:

  • 列表内容
  • 列表内容
  • 列表内容

注：- + * 跟内容之间都要有一个空格；

有序列表

有序列表方法相同，用数字加点的方式

1
2
3
1. 列表内容
2. 列表内容
3. 列表内容

效果:

  1. 列表内容
  2. 列表内容
  3. 列表内容

列表嵌套

上一级和下一级之间敲三个空格即可，示例：

1
2
3
4
5
6
7
8
- 一级无序列表内容
   - 二级无序列表内容
   * 二级无序列表内容
   + 二级无序列表内容

1. hhh
   1. hhh
   2. hhh

效果：

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

表格

表格分三部分，表头，分割线，表格内容，示例代码如下：

1
2
3
4
表头|表头|表头
---|:--:|--:
内容|内容|内容
内容|内容|内容

效果：

表头 表头 表头
内容 内容 内容
内容 内容 内容

注：分割线的 --- 代表靠左， :-: 代表居中，--:代表靠右。

附加一个用 Python 写的小工具，将表格数据自动转化为 Markdown 形式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import pyperclip
def list_to_MDTable(content, title=None,copy=True):
    '''将列表转化为 Markdown 格式'''
    # 表格第二行格式（居中）
    align = "|".join([":-:"]*len(content[0]))
    # 行内元素用 | 分割
    content = ["|".join(str(i) for i in line) for line in content] 
    # 设置标题
    if title is None: # 标题未定义，提取列表第一行作为标题
        title = content[0]
        content = content[1:]
    else:
        title = "|".join(str(i) for i in title)
    # 合并，导出文本
    txt = "\n".join([title,align,*content]) 
    if copy: pyperclip.copy(txt)
    return txt

代码高亮

容易发现，涉及代码的部分，本文都放在一个小卡片里，这其实就是代码高亮。

通过三个反斜点 ``` 将代码段包围，示例：

```
print(“hello”)
```

显示效果：

1
print("hello")

三个点后通常加代码的语言，比如 “```python” 代表被包围的代码段时 Python 语言

1
print("hello")

此时会使用该语言的颜色效果进行展示。

以上，算下来 Markdown 基础语法还不到十条，学习简单，多写几次就熟练了。

这些语法很多地方都支持，比如你现在在看的这个网站，比如 Jupyter—Notebook 等等。