markdown 开发手册学习整理

(Markdown语法没有一个统一的标准,不同的工具或平台采用的标准不一样,所以有些语法规则和功能是有差异的)

1 粗体&斜体

代码:

 *斜体* or _斜体_
 **粗体**
 ***加粗+斜体***
 ~~删除线~~
复制代码

效果

斜体 or 斜体

粗体

加粗+斜体

删除线


2.分级标题

代码:

# 一级
## 二级
...
###### 六级
复制代码

效果:

一级

二级

...

六级

3.超链接

Markdown 支持两种形式的链接语法:行内式和参考式两种形式,行内式一般使用较多。

3.1 行内式

语法说明:

[]里写链接文字,()里写链接地址,()中的""中可以为链接指定title属性,title属性加可不加。title属性的效果是鼠标悬停在链接上出现指定的 title文字。链接文字这样的形式。链接地址与链接标题前有一个空格。

[百度链](www.baidu.com "百度首页")
复制代码

效果

百度链

3.2参考式

参考式超链接一般用在学术论文上面,或另一种情况,如果某一个链接在文章中多处使用,么使用引用的方式创建链接将非常好,它可以让你对链接进行一的管理。

语法说明:

参考式链接分为两部分,文中的写法 [链接文字][链接标记],在文本的任意位置添加[链接标记]:链接地址 "链接标题",链接地址与链接标题前有一个空格。
如果链接文字本身可以做为链接标记,你也以写成[链接文字][]

代码:

上面是调用链接[百度][1]、[知乎][2]还有一种是文字作为来接标记][]
[1]:http://www.baidu.com "百度"
[2]:https://www.zhihu.com "知乎"
[文字作为来接标记]:https//www.word.com
复制代码

效果

上面是调用链接[百度][1]、[知乎][2]还有一种是文字作为来接标记][]。 [1]:www.baidu.com "百度" [2]:www.zhihu.com "知乎" [文字作为来接标记]:https//www.word.com

掘金 不支持这种方式

3.3 自动连接

语法说明:

Markdown支持以比较简短的自动链接形式来处理网址和电子件信箱,只要是用<>;包起来, Markdown就会自动把它转成链接。一般网址的链接文字就和接地址一样,例如:

代码:


复制代码

效果

baidu.com


4.锚点

注意:#### Markdown Extra只支持在标题后插入锚点,其它地方无效。

语法描述:

在你准备跳转到的指定标题后插入锚点{#标记},然后在文档的其它地方写上连接到锚点的链接。

代码

目标 目录{#index}
锚点 [目录](#index)
复制代码

效果

锚点{#maodian} 锚点


5.列表

5.1 无序列表

使用 *,+,- 表示无序列表。

代码:

- 无需列表 1
- 无需列表 2
- 无需列表 3
复制代码

效果

  • 无需列表 1
  • 无需列表 2
  • 无需列表 3

5.2 有序列表

有序列表则使用数字接着一个英文句点。回车自动排序

代码:

1. 有序1
2. 有序2
3. 有序3
复制代码

效果:

  1. 有序1
  2. 有序2
  3. 有序3

5.3 定义型列表

语法说明:

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

代码:

Markdown
:   轻量级文本标记语言,可以转换成html,pdf等格式(左侧有一个可见的冒号和四个不可见的空格)
代码
:   这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)
        代码块(左侧有八个不可见的空格)
复制代码

效果

... 掘金支持效果不一样

5.4 列表缩进

语法说明:

列表项目标记通常是放在最左边,但是其实也可以缩进,最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符。
*   这是有缩进的列表文字
复制代码

效果:

  • 这是有缩进的列表文字 (恕我没看出啥差)

5.5 包含段落的列表

语法说明:

列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符(显示效果与代码一致):
*    轻轻的我走了, 正如我轻轻的来;
    那榆荫下的一潭, 不是清泉
*   悄悄的我走了, 正如我悄悄的来
复制代码

效果:

  • 轻轻的我走了, 正如我轻轻的来;

    那榆荫下的一潭, 不是清泉。

  • 悄悄的我走了, 正如我悄悄的来

5.6 包含引用的列表

语法说明:

如果要在列表项目内放进引用,那 > 就需要缩进:

代码:

+ 阅读方法

> 打开书本。
> 打开电灯。
复制代码

效果

  • 阅读方法

打开书本。 打开电灯。


6.引用

语法说明:

引用需要在被引用的文本前加上>符号。

代码:

> 这是一个有两段文字的引用,
>无意义的占行文字1.
>无意义的占行文字2.
>
>无意义的占行文字3.
>无意义的占行文字4.
复制代码

显示效果:

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

无意义的占行文字3. 无意义的占行文字4. 这是一个有两段文字的引用,

6.1 引用的多层嵌套

区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 >:
注意:要空行

代码:

>>> 请问 Markdwon 怎么用? - 小白
>>
>>自己看教程! - 愤青
>
>教程在哪? - 小白
复制代码

显示效果:

请问 Markdwon 怎么用? - 小白

自己看教程! - 愤青

教程在哪? - 小白

6.2 引用其他要素

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

代码:

> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
>
> 给出一些例子代码:
> 
>     return shell_exec("echo $input | $markdown_script");
复制代码

显示效果

  1. 这是第一行列表项。
  2. 这是第二行列表项。

给出一些例子代码:

  return shell_exec("echo $input | $markdown_script");
复制代码

7.插入图像

图片的创建方式与超链接相似,而且和超链接一样也有两种写法,行内式和参考式写法。
语法中图片Alt的意思是如果图片因为某些原因不能显示,就用定义的图片Alt文字来代替图片。 图片Title则和链接中的Title一样,表示鼠标悬停与图片上时出现的文字。 Alt 和 Title 都不是必须的,可以省略,但建议写上。

7.1. 行内式

语法说明:![图片 Alt](图片地址 "图片Title")

代码:


![快乐学习](https://user-gold-cdn.xitu.io/2019/1/29/16898ccd0d4472c5?w=600&h=360&f=png&s=394211 "快乐学习")
复制代码

效果:

快乐学习


8.


9.主教

语法说明:

在需要添加注脚的文字后加上脚注[^注脚名字],称为加注。 然后在文本的任意位置(一般在最后)添加脚注,脚注前必须有对应的脚注名字。
注意:经测试注脚与注脚之间必须空一行,不然会失效。成功后会发现,即使你没有把注脚写在文末,经Markdown转换后,也会自动归类到文章的最后。

代码:

使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用简书或者支持Markdown的编辑器进行书写。
[^1]:Markdown是一种纯文本标记语言

[^2]:HyperText Markup Language 超文本标记语言
复制代码

效果:

使用 Markdown[1]可以效率的书写文档, 直接转换成 HTML[2], 你可以使用简书或者支持Markdown的编辑器进行书写。


10.数学公式:


11.表格

语法说明:

  1. 不管是哪种方式,第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行。
  2. 列于列之间用管道符|隔开。原生方式的表格每一行的两边也要有管道符。
  3. 第二行还可以为不同的列指定对齐方向。默认为左对齐,在-右边加上:就右对齐。

代码&效果:

简单方式:

学号|姓名|分数
-|-|-
小明|男|75
小红|女|79
小陆|男|92
复制代码
学号 姓名 分数
小明 75
小红 79
小陆 92

原生方式写表格:

|学号|姓名|分数|
|-|-|-|
|小明|男|75|
|小红|女|79|
|小陆|男|92|
复制代码
学号 姓名 分数
小明 75
小红 79
小陆 92

为表格第二列指定方向:

学号|姓名|分数
-|-:|-
小明|男|75
复制代码
学号 姓名 分数
小明 75

12.分割线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

代码:

* * *
***
*****
- - - 
--------------------------------------
复制代码

13.代码

  1. 行内 ` code`
  2. 块级 ``` code```

源码:

"2">值班人员 星期一 星期二 星期三
李强 张明 王平
复制代码

效果

值班人员 星期一 星期二 星期三
李强 张明 王平

14.todo list

代码:

近期任务安排:
- [x] 整理Markdown手册
- [ ] 改善项目
   - [x] 优化首页显示方式
   - [x] 修复闪退问题
   - [ ] 修复视频卡顿
- [ ] A3项目修复
   - [x] 修复数值错误
复制代码

效果

  • 整理md手册
  • 改善项目
    • 优化首页
    • 优化
  • A3 项目修复
    • 修复x

15.时序图 (注:掘金Markdown不支持时序图)

sequence
participant 客户端 as A
participant 服务端 as B
participant 通行证中心 as C
Note over A:用户输入通行证账号、密码
A->C: 发送账号、密码
Note over C:验证账号、密码
C-->>A:返回token
A->B:发送token
B->C:验证token
C-->>B:验证成功
B-->>A:登陆成功
Note left of A:左边注释
B->B:自交互
Note right of C:右边注释
复制代码

16. 流程图 (注:掘金Markdown不支持流程图)

st=>start: 开始
io=>inputoutput: 验证
op=>operation: 选项
cond=>condition: 是 或 否?
sub=>subroutine: 子程序
e=>end: 结束
st->io->op->cond
cond(yes)->e
cond(no)->sub->io
复制代码

17. 甘特图 (注:掘金Markdown不支持甘特图)

gantt
dateFormat YYYY-MM-DD
title 产品计划表
section 初期阶段
明确需求: 2017-03-01, 10d
section 中期阶段
跟进开发: 2017-03-11, 9d
section 后期阶段
抽查测试: 2017-03-20, 9d
复制代码

本文学习自迟道的《Markdown 语法手册完整整理》。


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

  2. HyperText Markup Language 超文本标记语言 ↩︎

你可能感兴趣的:(markdown 开发手册学习整理)