MarkDown语法

简介

Markdown是一种轻量级标记语言,它运行人们使用易读写的纯文本格式编写文档。MarkDown是2004年又约翰·格鲁伯创建的。MarkDown编写的文档可以导出HTML、Word、图像、PDF、Epub等多种格式。

一.标题

规则:文字前面多少“#”代表着多个级标题,最多支持六级标题,下面为各级标题的显示效果

MarkDown中输入如下:

#一级标题
##二级标题
###三级标题
####四级标题
#####五极标题
######六级标题

实际显示效果如下:

一级标题

二级标题

三级标题

四级标题

五极标题
六级标题


二、字体

2.1 斜体

规则:在文字字两边用“*”包起来

MarkDown中输入如下:

*这是斜体*

实际显示效果如下:

这是斜体

2.2 加粗

规则:在文字两边用“**”包起来

MarkDown中输入如下:

**这是粗体**

实际显示效果如下:

这是粗体


2.3 斜体加粗

规则:在文字两边用三个“***”包起来

MarkDown输入如下:

***这是斜体加粗***

实际显示效果如下:

这是斜体加粗

2.4 删除线

规则:在文字两边分别用“~~”包起来

MarkDown输入如下:

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

实际显示效果如下:

这是删除线的文字


三、引用

3.1 单级引用

规则:在文字前面加“>”即可

MarkDown输入如下:

>引用

实际显示效果如下

引用


3.2多级引用

规则:在文字前面加多个“>”即可,几级就加几个,貌似可以无限添加,不过意义不大。,下面为二级引用的例子。

MarkDown输入如下:

>>这是多级引用

实际显示效果如下

这是多级引用


四、分割线

规则:在一行使用三个以上的星(*)或者三个减号(-)或者三个下滑线(_)

markdown中输入如下:

***

---

___

实际效果显示如下:




备注:这三种其实是有点差别的,但是在很多markdown平台上显示都是一样。

五、图片

规则:一个感叹号加上中括号,中括号内为图片简介后面是括号,括号内是图片地址
markdown中输入如下:

![沉船湾](https://upload-images.jianshu.io/upload_images/14400859-7ae0207d195659cb.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

实际显示效果如下:

沉船湾


六、超链接

规则:先是一个种括号,中括号内的内容为超链接简介,然后是括号,括号内为超链接地址
markdown输入如下:

[百度](https://www.baidu.com)
[简书](http://jianshu.com)
[知乎](https://www.zhihu.com)

实际显示效果如下:
百度

简书

知乎

七、列表

7.1 无序列表

规则:在条目前面加上“-”、“+”、“*”三种中任意一种后,在后面加个空格,再加上条目内容。
markdown上输入如下:

- 条目一
+ 条目二
* 条目三

实际显示效果如下:

  • 条目一
  • 条目二
  • 条目三

备注:条目上部需要与其他内容有个换行,不然会导致无法识别,在条目中换行会自动增加新的条目(部分平台可以简书不可以)

7.2 有序列表

规则:序号加空格加内容

markdown输入如下:

1. 条目一
2. 条目二
3. 条目三

实际显示效果如下:

  1. 条目一
  2. 条目二
  3. 条目三

下面是正常输入的效果
1.条目一
2.条目二
3.条目三
对比可以发现条目离顶部和底部的距离增加了

备注:条目上部需要与其他内容有个换行,不然会导致无法识别。在条目中换行会自动增加新的条目(部分平台上可以,简书不可以)


八、表格

规则:

表头|表头|表头
:-|:-:|-:
内容|内容|内容
内容|内容|内容



说明:表头和内容都使用“|”来分隔,表头只有一行,表头下一行表示当前列的对齐方式,对齐方式有三种

  • -:   表示左对齐
  • :-:  表示居中
  • :-   表示右对齐

markdown输入如下:

表头|表头|表头
:-|:-:|-:
向左对齐|居中|向右对齐
内容|内容|内容
内容|内容|内容

实际显示效果如下:

表头 表头 表头
向左对齐 居中 向右对齐
内容 内容 内容
内容 内容 内容


九、代码

9.1 单行代码

规则:直接在代码前后加上“`”

markdown输入如下:

`System.out.print("Hello Word!");`

实际显示效果如下:
System.out.print("Hello Word!");
备注:实现其他需要高亮效果的文字也可以使用。

9.2 代码块:

规则:直接在代码上下加上“```“,在第一个“```”后可以指定代码类型
markdown输入如下:

```java
private void print(){
   System.out.print("Hellow word!");
}
```

实际显示效果如下:

private void print(){
    System.out.print("Hellow word!");
}

备注:还有一种方式是在每一行代码前增加缩进(Tab),也可以实现代码块效果

十、空格和换行

10.1 空格

规则:使用     三个中的任何一个均可表示空格,但表示的含义不太相同
含义:
  :表示一个汉字大小
  :表示一个大写英文大小
  :表示一个小写英文大小
markdown中输入如下

 字
汉字

  ABB
AABB

  abb
aabb

实际显示效果如下:
 字
汉字

  ABB
AABB

  abb
aabb

备注:markdown只能识别半角状态下的一个空格,多的会没效果,但输入法切换到全角后输入空格均可正常使用,一般切换全角的快捷键是shift+空格。

10.2 换行

规则:使用Html的<br>标签即可。
markdown输入如下:

这是第一行
<br>
这是第三行

实际显示效果如下:
这是第一行


这是第三行

十一、Html支持

介绍:markdown内联了Html语法,所以可以直接使用Html语法来编写,但目前支持的语法还不是很多,但比较常用的字体大小和字体颜色还是支持的。下面是一个字体颜色和大小的例子:

markdown输入如下

<font color=#0099ff size=12 >黑体</font>

实际显示效果如下:

<font color=#0099ff size=12 >黑体</font>


十二、任务列表

规则:- [ ] 任务名 表示未做任务
   - [x] 任务名 表示已做任务

markdown输入如下:

- [ ] 任务一 未做任务 
- [x] 任务二 已做任务 

实际显示效果如下:

  • 任务一 未做任务
  • 任务二 已做任务


十三、流程图

由于markdown的流程图是使用代码写的,可能并没有直接画的那么直观,不过这是一个非常不错尝试,markdown是真的能让所有操作都只依赖键盘,这是非常强大的。由于简书等平台并不支持,所以我比较倾向于画图软件,所以这里只简单的说下语法。
规则:

```flow
st=>start: 开始
op=>operation: 操作
cond1=>condition: 条件1
cond2=>condition: 条件2
sub=>subroutine: 子系统
io=>inputoutput: 输入或产出
e=>end: 结束
st->op->cond1
cond1(yes)->cond2
cond1(no)->sub
cond2(no)->io
cond2(yes)->e
```

语法解析:首先最顶部需要添加“```mermaid
flowchat”,然后最底部需要添加“```”,其余中间部分的语法如下:
st=>start: 开始可以理解为:变量名=>变量类型: 变量值
变量名可以自定义,
变量值为该变量显示的名称
变量类型有六种,分别为

  • start:表示开始
  • operation:表示操作
  • condition:表示条件
  • subroutine:表示子程序
  • inputoutput:表示输入或输出
  • end:表示结束

st->op->cond1表示连线,这里可以看出是从st变量连接到op变量再连接到cond1变量
cond1(yes)->cond2由于cond1变量是个条件,所以这里对应着yes的情况
cond1(no)->sub由于cond1变量是个条件,所以这里对应着no的情况

上面的代码,实现显示如下:

流程图

备注:由于简书暂不支持流程图,所以这里只能放一张图片展示效果

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351