Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown 速查表 #37

Open
Ray-56 opened this issue Nov 6, 2020 · 0 comments
Open

Markdown 速查表 #37

Ray-56 opened this issue Nov 6, 2020 · 0 comments
Labels
Cheat Sheet 速查表,翻译:作弊用纸、小抄,但是它是合法的。 Markdown

Comments

@Ray-56
Copy link
Owner

Ray-56 commented Nov 6, 2020

Markdown 速查表

目录

[TOC]

1、斜体和粗体

*斜体*或_斜体_
**粗体**
***加粗斜体***
~~删除线~~

斜体或_斜体_
粗体
加粗斜体
删除线

2、分级标题{#2}

# 一级标题
## 二级标题
### 三级标题

使用了[TOC]就会把所有的标题写入到目录大纲中,当前目录就是如此生成

3、超链接

3-1、行内式

这是[baidu](https://www.baidu.com/)  
这是[Google](https://www.google.com/)  

这是baidu
这是Google

3-2、参考式

一般用在学术论文上面,或者某个链接有多处使用

面向[Google][1]编程
或者面向[百度][2]编程

面向[Google][]的话有用的信息更多一点

[1]:https://www.google.com/
[2]:https://www.baidu.com/
[Google]:https://www.google.com/

面向Google编程
或者面向百度编程

面向Google的话有用的信息更多一点

3-3、自动链接

<http://example.com>
<[email protected]>

http://example.com
[email protected]

4、锚点

锚点也就是链接文档内部的某些元素,实现当前页面中的跳转

## 0、跳转测试{#index}

跳转到[跳转测试](#index)

5、列表

5-1、无序列表

使用* + -表示无序列表

- 无序列表项1
- 无序列表项2
  • 无序列表项1
  • 无序列表项2

5-2、有序列表

1. 有序列表项1
2. 有序列表项2
  1. 有序列表项1
  2. 有序列表项2

5-3、定义型列表

由名词和解释组成。一行写上定义,紧跟一行写上解释。解释的写法:紧跟一个缩进(Tab)

代码块1 Markdown
:   轻量级文本标记语言,可以转成 HTML,PDF 等格式(左侧有一个可见的冒号和四个不可见的空格)

代码块2
:   这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)

        代码块(左侧有八个不可见的空格)

代码块1 Markdown
: 轻量级文本标记语言,可以转成 HTML,PDF 等格式(左侧有一个可见的冒号和四个不可见的空格)

代码块2
: 这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)

    代码块(左侧有八个不可见的空格)

5-3-1、列表缩进

列表项目标记通常放在最左边,但其实也可以缩进,最多三个空格,项目标记后面则一定要接着至少一个空格或制表符

*    轻轻的我走了,正如我轻轻的来;我轻轻的挥手,作别西天的云彩。那河畔的金柳,是夕阳中的新娘;波光里的艳影,在我心头荡漾。软泥上的靑荇,油油的在水底招摇;在康河的柔波里,我甘心做一条水草!
*		 那榆萌下的一潭,不是清泉,是天上虹;揉碎在浮藻间,沉淀着彩虹似的梦。寻梦?撑一只长篙,向青草更深处漫溯;满载一船星辉,在星辉斑斓里放歌。但我不能放歌,悄悄是别离的笙箫;夏虫也为我沉默,沉默是今晚的康桥!悄悄的我走了,正如我悄悄的来;我挥一挥衣袖,不带走一片云彩。
  • 轻轻的我走了,正如我轻轻的来;我轻轻的挥手,作别西天的云彩。那河畔的金柳,是夕阳中的新娘;波光里的艳影,在我心头荡漾。软泥上的靑荇,油油的在水底招摇;在康河的柔波里,我甘心做一条水草!
  •    那榆萌下的一潭,不是清泉,是天上虹;揉碎在浮藻间,沉淀着彩虹似的梦。寻梦?撑一只长篙,向青草更深处漫溯;满载一船星辉,在星辉斑斓里放歌。但我不能放歌,悄悄是别离的笙箫;夏虫也为我沉默,沉默是今晚的康桥!悄悄的我走了,正如我悄悄的来;我挥一挥衣袖,不带走一片云彩。
    

5-4、包含段落的列表

列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符(显示效果与代码一致

*   轻轻的我走了,正如我轻轻的来;我轻轻的招手,作别西天的云彩。
那河畔的金柳,是夕阳中的新娘;波光里的艳影,在我心头荡漾。
软泥上的靑荇,油油的在水底招摇;在康河的柔波里,我甘心做一条水草!

	那榆荫下的一潭,不是清泉,是天上虹;揉碎在浮藻间,沉淀着彩虹似的梦。
寻梦?撑一支长篙,向青草更青处漫溯;满载一船星辉,在星辉斑斓里放歌。
但我不能放歌,悄悄是别离的笙箫;夏虫也为我沉默,沉默是今晚的康桥!

*   悄悄的我走了,正如我悄悄的来;我挥一挥衣袖,不带走一片云彩。
  • 轻轻的我走了,正如我轻轻的来;我轻轻的招手,作别西天的云彩。
    那河畔的金柳,是夕阳中的新娘;波光里的艳影,在我心头荡漾。
    软泥上的靑荇,油油的在水底招摇;在康河的柔波里,我甘心做一条水草!

    那榆荫下的一潭,不是清泉,是天上虹;揉碎在浮藻间,沉淀着彩虹似的梦。
    寻梦?撑一支长篙,向青草更青处漫溯;满载一船星辉,在星辉斑斓里放歌。
    但我不能放歌,悄悄是别离的笙箫;夏虫也为我沉默,沉默是今晚的康桥!

  • 悄悄的我走了,正如我悄悄的来;我挥一挥衣袖,不带走一片云彩。

5-5、包含引用的列表

* 阅读的方法:
  > 打开书本
  > 打开电灯
  • 阅读的方法:

    打开书本
    打开电灯

5-6、包含代码块的引用

如果要放代码区块的话,该区域就要缩进两次,也就是 8 个空格或是 2 个制表符

* 下面是代码块
		const URL = "google.com";
  • 下面是代码块
    const URL = "google.com";

5-7、一个特殊的情况

在特殊情况下,列表项目很可能会不小心产生,向下面这样的写法:

1892. 这是第 1892 个

可能会显示成

1. 这是第 1892 个

也就是首行出现数字-句点-空白,要避免这样的情况,可以在句点前面加上反斜杠:

1892\. 这是第 1892 个

才会正常显示成:

1892. 这是第 1892 个

6、引用

> 这是一个有两段文字的引用
无意义的占行文字1
无意义的占行文字2

> 无意义的占行文字3
无意义的占行文字4

这是一个有两段文字的引用
无意义的占行文字1
无意义的占行文字2

无意义的占行文字3
无意义的占行文字4

6-1、引用的多层嵌套

>>> 请问 Mardown 怎么用 - 小白

>> 自己看教程! - 愤青

> 教程在哪里? - 小白

请问 Mardown 怎么用 - 小白

自己看教程! - 愤青

教程在哪里? - 小白

6-2、引用其它要素

引用的区块内也可以使用其它的 Markdown 语法,包含标题、列表、代码块等

> 1. 这是第一行列表项
> 2. 这是第二行列表项
>
> 给出一些例子代码:
>
>     const url = 'baidu.com';
  1. 这是第一行列表项
  2. 这是第二行列表项

给出一些例子代码:

const url = 'baidu.com';

7、内容目录

在段落中填写[TOC]以显示全文内荣的目录结构

效果看当前文档最上方的目录

8、注脚

使用 Markdown[^1] 可以效率的书写文档,直接转换成 HTML[^2] 或 PDF,你可以使用 Typora[^Ty] 编辑器进行书写

[^1]: Markdown 是一种纯文本标记语言

[^2]: HyperTextMarkupLanguage 超文本标记语言

[^Ty]: 开源的 Markdown 编辑器

使用 Markdown1 可以效率的书写文档,直接转换成 HTML2 或 PDF,你可以使用 Typora3 编辑器进行书写

注:注脚自动被搬运到最后面,请到文章末尾查看,并且注脚后方的链接可以直接跳转回到加注的地方。

9、LaTeX 公式

使用较少 访问 MathJax 参考更多使用方法。

9-1、 $ 表示行内公式:

质能守恒方程式可以用一个很简洁的方程式 $E=mc^2$ 来表示。

质能守恒方程式可以用一个很简洁的方程式 $E=mc^2$ 来表示。

10、表格

第一行为表头,第二行为分隔表头和主体部分,第三行开始每一行是一个表格行。

列与列之间用管道符|隔开。原生方式的表格每一行的两边也要有管道符。第二行还可以为不同的列指定对齐方式。默认为左对齐,:在哪边就是哪边对齐。

1. 简单方式写表格:
学号|姓名|分数
-|-|-
小明|男|66
小红|女|88
小鹿|男|99
2. 原生方式写表格:
|学号|姓名|分数|
|-|-|-|
|小明|男|66|
|小红|女|88|
|小鹿|男|99|
3. 第二列指定方向(右)
姓名|备注
-|-:
小明|短备注
小红|长长长长长长长长长长备注
  1. 简单方式写表格:
    学号|姓名|分数
    -|-|-
    小明|男|66
    小红|女|88
    小鹿|男|99
  2. 原生方式写表格:
    |学号|姓名|分数|
    |-|-|-|
    |小明|男|66|
    |小红|女|88|
    |小鹿|男|99|
  3. 第二列指定方向(右)
    姓名|备注
    -|-:
    小明|短备注
    小红|长长长长长长长长长长备注

11、分割线

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

显示效果都一样

12、代码

  1. 行内
  2. 多行
    • ```
    • 缩进

12-1、使用 Diff

```diff
- const TYPE = 1;
+ const TyPE = 2;
```

显示效果:

- const TYPE = 1;
+ const TyPE = 2;

Toggle

<details>
<summary>Click to toggle contents of `code`</summary>
```
CODE!
```
</details>

显示效果:查看文章开头目录

See Also

Footnotes

  1. Markdown 是一种纯文本标记语言

  2. HyperTextMarkupLanguage 超文本标记语言

  3. 开源的 Markdown 编辑器

@Ray-56 Ray-56 added the Markdown label Nov 6, 2020
@Ray-56 Ray-56 added the Cheat Sheet 速查表,翻译:作弊用纸、小抄,但是它是合法的。 label Aug 12, 2021
@Ray-56 Ray-56 changed the title Markdown的一些用法 Markdown 速查表 Aug 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cheat Sheet 速查表,翻译:作弊用纸、小抄,但是它是合法的。 Markdown
Projects
None yet
Development

No branches or pull requests

1 participant