markdown语法

Markdown是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。通过简单的标记语法,它可以使普通文本内容具有一定的格式。

  • 优点:
    1、因为是纯文本,所以只要支持Markdown的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰,专心写作。
    2、操作简单。一些简单的语法,就能实现各种格式和需求。
    3、编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  • 缺点:
    1、需要记一些语法(很简单,基本是几分钟就可以学会)。
    2、有些平台不支持Markdown编辑模式

一些支持markdown语法的平台,Github、简书、CSDN、有道云笔记等。

编辑器

推荐使用vs code、Typora来进行编写,具有及时预览和支持跨平台的特点,十分的方便。附上下载链接:

1. 标题

通过 # 号的个数来分辨标题的类型,一般有六级标题(#号与文字之间有个空格space):

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

效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

2. 字体样式

  • 加粗

需要加粗的文本两段分别用两个 * 号或两个 _ 包起来

**这是加粗文本1**
__这是加粗文本2__

效果:
这是加粗文本1
这是加粗文本2

  • 斜体

需要斜体的文本两段分别用一个 * 号或一个 _ 包起来

*这是斜体文本1*
_这是斜体文本2_

效果:
这是斜体文本1
这是斜体文本2

  • 加粗斜体

需要加粗斜体的文本两段分别用三个 * 号或三个 _ 包起来

***这是加粗斜体文本1***
___这是加粗斜体文本2___

效果:
这是加粗斜体文本1
这是加粗斜体文本2

  • 删除线

需要删除线的文本两段分别用两个 ~~ 包起来

~~这是需要删除线文本~~

效果:
这是需要删除线文本

  • 引用

在段落开头使用 > 符号可以实现缩进,另外引用是可以嵌套的,一个、两个、...、n个以此类推退:

>这是需要引用文本 1
>>这是需要引用文本 2
>>>这是需要引用文本 3

效果:

这是需要引用文本 1

这是需要引用文本 2

这是需要引用文本 3

段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个或以上空格<space>加上回车。

第一段内容<space><space>
第二段内容

效果:
第一段内容
第二段内容

列表

  • 无序列表

用 - + * 任何一种符号加上一个空格<space>都可以实现

- 列表内容1
+ 列表内容2
* 列表内容3

效果:

  • 列表内容1
  • 列表内容2
  • 列表内容3
  • 有序列表

数字加上符号点 . ,再加上一个空格<space>

1. 列表内容1
2. 列表内容2
3. 列表内容3

效果:

  1. 列表内容1
  2. 列表内容2
  3. 列表内容3
  • 列表嵌套

上一级和下一级之间敲三个 空格<space> 即可

1. 第一项   
   - 第一项的嵌套内容1
   - 第一项的嵌套内容2
2. 第二项   
   - 第二项的嵌套内容1
   - 第二项的嵌套内容2

效果:

  1. 第一项
    • 第一项的嵌套内容1
      • 第一项的嵌套的嵌套内容1
      • 第一项的嵌套的嵌套内容2
    • 第一项的嵌套内容2
  2. 第二项
    • 第二项的嵌套内容1
    • 第二项的嵌套内容2

表格

Markdown 制作表格使用 | 来分隔不同的单元格,第二行分割表头和内容,并设置内容和标题栏的对齐格式。使用一个或多个 - 加上一个冒号 : 来表示。
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。

(分别是:左对齐、居中、右对齐)
姓名|明显特征|排行名次
:--|:--:|--:
苏明哲|要面子|老大
苏明成|啃老|老二
苏明玉|强势独立|老三

效果:

姓名 明显特征 排行名次
苏明哲 要面子 老大
苏明成 啃老 老二
苏明玉 强势独立 老三

代码块

单行代码:代码之间分别用一个反引号 ` 包起来
效果:
代码内容
代码块:分别用三个反引号 ` 包裹一段代码,并指定一种语言(也可以不指定),且两边的反引号单独占一行
效果:

\```lua
local str = "markdown is very useful"
print(str)
\```
\是为了转义,使用时去掉

链接

网页跳转,Markdown本身语法不支持链接在新页面中打开,而一些平台可能做了处理,语法:

[alt名字](超链接地址 "超链接title")
alt名字是显示在页面上的名字
title是链接的标题,当鼠标移到链接上时显示的内容。title可以不加

示例:

[Markdown教程](https://github.com/qiuwener/markdown "Markdown教程")
[Git与Github教程](https://blog.csdn.net/qiuwen_521/article/details/89283186)

效果:
Markdown教程
Git与Github教程

图片

语法:

![alt名字](图片路径 "图片title")
alt就是显示在图片下面的文字,相当于对图片内容的解释。
title是图片的标题,当鼠标移到图片上时显示的内容。title可以不加

示例:

![markdown图标](http://www.runoob.com/wp-content/uploads/2019/03/iconfinder_markdown_298823.png "markdown图标")

效果:


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

推荐阅读更多精彩内容