M↓(Markdown) 使用手册

Markdown (M↓) 之旅

Preface

Markdown是一种轻量级的标记语言,允许人们使用易读易写的纯文本格式编写文档,是写博客、论文的绝佳工具。Markdown可以被转为html,pdf,word格式文档。

1. 选择
  1.1 VSCode + Extension
  1.2 Typora
2. Markdown语法
  2.1 文本样式
    2.1.1 斜体·加粗·删除线
    2.1.2 强调
  2.2 标题
  2.3 分段
  2.4 引用
    2.4.1 单行引用
    2.4.2 多行引用
    2.4.3 嵌套引用
  2.5 列表list
    2.5.1 无序列表
    2.5.2 有序列表
    2.5.3 嵌套列表
  2.6 链接
    2.6.1 直接链接
    2.6.2 链接名
    2.6.3 多个同名链接
  2.7 图片
  2.8 代码
    2.8.1 单行代码
    2.8.2 多行代码
  2.9 表格

1. 选择

这里介绍两种使用方式

1. 1. VSCode + Extension

Visual Studio Code isn’t a dedicated Markdown editor, but has the functionality to be used as one all the same. VS Code provides Markdown editing capabilities out-of-the-box, but you can install an extension for even greater functionality, like shortcuts, creating a table of contents, and more.

( Visual Studio Code 不是专用的 Markdown 编辑器,但具有相同的功能。 VS Code 提供了开箱即用的 Markdown 编辑功能,但您可以安装扩展以获得更多功能,例如快捷方式、创建目录等 )

我选择的就是这个方式,因为左边是M↓(Markdown)语法,右边可以预览,显示它的preview。我认为对于新手而言,这种分页式更友好,更利于熟悉语法。

VSCode 是代码编辑器,无需多言,而其上的extension也有不少,我目前用的是markdownlintMarkdown Preview Github Styling。当然也有Markdown All In One等优秀的extension可供选择。

1. 2. Typora

Typora is one of the most popular Markdown editors, and for good reason. Unlike many of the editors you’ll find on this list, Typora automatically hides Markdown formatting, showing a preview of the final document instead.

It’s a robust editor with support for advanced Markdown features such as mathematics and diagrams, and a wide range of export options.

( Typora 是最受欢迎的 Markdown 编辑器之一,这是有充分理由的。与您在此列表中找到的许多编辑器不同,Typora 会自动隐藏 Markdown 格式,而是显示最终文档的预览。
它是一个强大的编辑器,支持高级 Markdown 功能,例如数学和图表,以及广泛的导出选项 )

Typora不支持分栏,预览,我认为更适用于运用熟练的Markdowner。

当然,还有MacDown, Draft, Ulysses等编辑器可供使用。大家可以自行选择。

2. Markdown 语法

2.1. 文本样式

2. 1. 1. 斜体·加粗·删除线

*斜体 * or \_斜体_

* 加粗 *

*斜体加粗 or \___斜体加粗 __( 3个 )

\~~删除线~~

  • 注:* ~与文本之间不能有空格

2. 1. 2. 强调

* 123 + 123 - 123

* 或 + 或 - 加空格 可以产生以下效果:

  • 123

- * 123

连用2个 * 或 + 或 - 加空格 可以产生以下效果:

    • 123

`+ + + 123
`

连用3个* 或 + 或 - 加空格 可以产生以下效果:

      • 123
  • 取消强调

若想让*可见,加上 ' \ ' 即可:

\*取消强调 效果:*取消强调

2.2. 标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题
  • 注:
    1.#与标题间需要空格\
    2.最多有6级标题

2.3. 分段

I have eaten
the plums
that were in
the icebox

的效果是:
I have eaten
the plums
that were in
the icebox

I have eaten\
the plums\
that were in\
the icebox

的效果是:

I have eaten\
the plums\
that were in\
the icebox

2.4. 引用

2. 4. 1. 单行引用

The quote “Somewhere, something incredible is waiting to be known” has been ascribed to Carl Sagan.

加入引用 :

The quote 
>Somewhere, something incredible is waiting to be known

has been ascribed to Carl Sagan.

效果:

The quote

Somewhere, something incredible is waiting to be known

has been ascribed to Carl Sagan.

2. 4. 2. 多行引用

Allowing an unimportant mistake to pass without comment is a wonderful social grace.

Ideological differences are no excuse for rudeness.

被引用后:

> Allowing an unimportant mistake to pass without comment is a wonderful social grace.
>
> Ideological differences are no excuse for rudeness.

效果:

Allowing an unimportant mistake to pass without comment is a wonderful social grace.

Ideological differences are no excuse for rudeness.

2. 4. 3.嵌套引用

套娃警告!

1

2

3

2.5. 列表list

2. 5. 1 无序列表

- Flour
- Cheese
- Tomatoes

效果:

  • Flour
  • Cheese
  • Tomatoes
* - + 3种符号都可以(使用同种符号才有list的效果,不同种符号行间距过大)

2. 5. 2 有序列表

Four steps to better sleep:
1. Stick to a sleep schedule
2. Create a bedtime ritual
6. Get comfortable
4. Manage stress

效果:

Four steps to better sleep:

  1. Stick to a sleep schedule
  2. Create a bedtime ritual
  3. Get comfortable
  4. Manage stress
  • 注:\
    1.标号只要从1开始,后面随便写,它会自动排序\
    2.序号与文本间需要空格

2. 5. 3 嵌套列表

上、下级之间需要2个空格

无序
* 一级
  * 二级 
  * 二级
    * 三级 

效果:

  • 一级

    • 二级
    • 二级

      • 三级
有序
1. 一级12. 一级2    1. 二级1    2. 二级2        1. 三级13. 一级3

效果:

  1. 一级1
  2. 一级2

    1. 二级1
    2. 二级2

      1. 三级1
  3. 一级3

若想取消标号,
12\. 取消顺序标号

1. 是打开或关闭12\. 取消顺序标号

效果:

  1. 是打开或关闭
    12. 取消顺序标号

2.6. 链接

2. 6. 1. 直接链接

You can search anything at

You can search anything at https://www.zhihu.com/

  • 不加<>也可以,但左右需要空格

2. 6. 2. 链接名

[链接名](链接地址)

如:
[stackoverflow](https://stackoverflow.com)

效果:
stackoverflow

2. 6. 3. 多个同名链接

[飓风][1]Erika是 1997 年大西洋[飓风][1]季节中最强和持续时间最长的热带气旋。[1]:https://baike.baidu.com/item/%E9%A3%93%E9%A3%8E/17274?fr=aladdin

飓风Erika是 1997 年大西洋飓风季节中最强和持续时间最长的热带气旋。

2.7. 图片

![alt](图片地址 "title")\
alt是图片下方文字,title是鼠标移到图片上显示的文字

如:

![](https://commonmark.org/help/images/favicon.png )

M↓(Markdown) 使用手册_第1张图片

此链接为 [巴斯光年][2] 图片[2]:https://gss0.baidu.com/70cFfyinKgQFm2e88IuM_a/baike/pic/item/500fd9f9d72a60590804cff62034349b023bbac1.jpg "buzz lightyear"

此链接为 巴斯光年 图片

2.8. 代码

2. 8. 1. 单行代码

\` x = 2 \`
效果: x = 2

2. 8. 2. 多行代码

\```\
x = y\
t = x\
y = t\
\```

效果:

x = yt = xy = t

`后面加上语言,markdown会自动根据语言的格式高亮

\```python\
for i in range(4):\

print(i)\

\```

for i in range(4):    print(i)

Who ate the most donuts this week?    Jeff  15    Sam   11    Robin  6

效果:

Who ate the most donuts this week?

Jeff  15Sam   11Robin  6

注:不是单引号',而是反单引号(`) ,对于多行代码 而言,~ ~也可以实现,但可能不是规范的语法

对于代码块中加入修饰文本的功能(如:加粗,斜体,加标题,改变字体大小等),我不知道如何做到,若有读者可以指点,感激不尽。

2.9. 表格

语法:

| 左对齐 | 右对齐 | 居中对齐 || :---- | ----: | :----: || 单元格 | 单元格 | 单元格 || 单元格 | 单元格 | 单元格 |

如:

| 学生姓名 | 年龄 | 班级 || :---- | ----: | :----: || 刘星     | 14 | 2 || 夏雪     | 17 | 3 |
学生姓名 年龄 班级
刘星 14 2
夏雪 17 3

后记

2019年夏天,也就是我高考完的那个暑假,哥哥就告诉我让我学习Markdown,说这个很有用也很好用,甚至把VSCode都下好了。没想到,近2年后,我才感受到它的用处,开始学习它。

你可能感兴趣的:(markdown)