orangelop

Markdown 使用教程

2020-03-16

Markdown是一门应用广泛的语言
主要还是程序员为程序写README时用
很简单,只要你想学就可以学会

标题

代码示例:

# 这是一级标题
## 这是二级标题
......
###### 这是六级标题

样例:
(最大一级最小六级,在Markdown中你只可以使用一个一级标题故不在示范)

这是二级标题

这是三级标题

这是四级标题

这是五级标题
这是六级标题

序号

代码示例:
Tips:用 - + * 任何一种都可以

无排序:
* Item 1  
* Item 2
    * Item 2a
    * Item 2b
有排序:
1.Item 1
2.Item 2
3.Item 3
  * Item 3a
  * Item 3b

样例:
(1)无排序:

  • Item 1
  • Item 2
    • Item 2a
    • Item 2b

(2)有排序:

  1. Item 1
  2. Item 2
  3. Item 3

插入图片

代码示例:

代码:
![图片alt](图片地址 ''图片title'')
图片alt就是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加

代码样例:
本地:
![testphoto](./test.png)

网上:
![testphoto](https://cdn.img.wenhairu.com/images/2020/03/15/mdtlD.png)

样例(只演示网上):

testphoto

插入链接

代码示例:

[我的博客](https://orangelop.github.io/)

样例:
我的博客

引用

代码示例:
(这段话来自狗屁不通生成器)

培根说过一句富有哲理的话:

> 深窥自己的心,而后发觉一切的奇迹在你自己。

样例:

培根说过一句富有哲理的话:

深窥自己的心,而后发觉一切的奇迹在你自己。

Tips:引用还可以千层套娃

代码示例:

> 培根说过一句富有哲理的话:
> > 深窥自己的心
> > > 而后发觉一切的奇迹在你自己

样例:

培根说过一句

富有哲理的话:

深窥自己的心

而后发

觉一切的

奇迹在

你自己

划重点时

斜体

代码示例:

*这是需要斜体的文字*
_这也是需要斜体的文字_

样例:

这是需要斜体的文字
这也是需要斜体的文字

删除线

代码示例:

~~这是要删除的字~~

样例:

这是要删除的字

加粗

代码示例:

**这是需要加粗的字**
__这也是需要加粗的字__

样例:
这是需要加粗的字
这也是需要加粗的字

TIPS:你也可以混用这些

代码示例:

**这是需要*这是需要~~这是要删除的字~~斜体的字*加粗的字**

样例:

这是需要这是需要这是要删除的字斜体的字加粗的字

Markdown下的转义符

它就是\
这个转义符如何使用呢,比如我想写这个

*这两个星号不用去掉*

而在Markdown下会成这样:

这两个星号不用去掉

怎么办呢?
只需要在星号前加上\就可以了。

代码示例:

\*这两个星号不用去掉\*  

样例:
*这两个星号不用去掉*

彩色字体

代码示例:

$\color{RGB颜色编号}{要显示的内容}$

样例:

比如我这里以想显示的内容为“红色”,颜色为红色来展示,代码就是这样:

$\color{#FF3030}{red}$

效果:
$\color{#FF3030}{red}$

Tips:你想要的颜色对应的RGB颜色编号可在这儿找到

清单

代码示例:

- [ ] 这个没完成
- [x] 这个完成了

样例:

  • 这个没完成
  • 这个完成了

表格

代码示例:

第一列 | 第二列
- | -
内容 | 内容
内容 | 内容

第二行分割表头和内容。
- 有一个就行
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右
注:原生的语法两边都要用 | 包起来。此处省略

样例:

第一列 第二列
内容 内容
内容 内容

分隔线

代码示例:

---
或
---- (三个以上的-)
或
***
或
***** (三个以上的*)

样例:


代码与代码块

代码

代码示例:

`这是代码`

样例:

这是代码

代码块

代码示例:

(```)
这是代码块
(```)

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

代码高亮

就是在代码块的代码后面加上语言名称在另起一行写代码就行了

代码示例:

示例:
(```)代码名
这是代码
(```)

样例:
(```)javascipt
document.getElementById("myH1").innerHTML="Welcome to my Homepage";
(```)

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

样例:

document.getElementById("myH1").innerHTML="Welcome to my Homepage";

居中

Tips:由于Markdown定义全支持html标记,所以你可以直接在Markdown里面写html语法。

代码示例:

<center>这是要居中的文字</center>

样例:

这是要居中的文字

锚点

这个点击后可以返回一个大节
不知道怎么解释,点一下就知道啦
点这儿会回到居中教程
点这儿会回到开头

代码示例:

[点这儿](#如何使用Markdown写文章)

样例:

点这儿

版本控制“diff”

版本控制的系统中都少不了diff的功能,即展示一个文件内容的增加与删除。

GFM中可以显示的展示diff效果。使用绿色表示新增,红色表示删除。

(因为VSCode也可以显示我就把它放在这儿啦)

代码示例:

其语法与代码高亮类似,只是在三个反引号后面写diff,
并且其内容中,以 +开头表示新增,-开头表示删除。

示例:
(```)diff
+ 鸟宿池边树,僧敲月下门
- 鸟宿池边树,僧推月下门
(```)

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

样例:

+ 鸟宿池边树,僧敲月下门
- 鸟宿池边树,僧推月下门

接下来的是Github专属的Markdown样式(GFM)

@某个人(Github用户名)

代码示例:

@Orangelop

样例(请在github上查看):
@Orangelop

EMOJI表情

Github支持的emoji表情可在这儿查看

代码示例:

:+1: (点赞)

样例(请在github上查看):
:+1:

链接Issues

Tips:GFM 在 Issues 中通过 # 和 数字 可以自动链接到对应的 issue,例如 #1024

代码示例:

#1

样例(请在github上查看):

#1



Content
Return Click here...