Markdown基础语法

1. 简述

Markdown是一种易读易写的纯文本标记语言,能够实现使用少量标记符号以最小的输入代价生成极富表现力的文档,也可以快速制作Todo列表、书写LaTex公式、高亮代码,也可以高效绘制流程图、甘特图和数据表格等,实现了流畅书写与印刷级阅读之间的一种平衡。

2. 段落和换行

语法说明:
一个Markdown段落是由一个或多个连续的文本组成,其前后又一个以上的空行

3. 分级标题

语法说明(类Atx形式):
在行首加井号(#)表示不同级别的标题 (H1-H6),例如:# H1, ## H2, ### H3,#### H4,……

代码示例:
# 一级标题
##二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

4. 斜体和粗体

语法说明:
使用 * 和 ** 表示斜体和粗体

代码示例:
*斜体*
**粗体**

5. 链接

语法说明:
使用 [描述](链接地址)为文字增加外链接,可以分为行内式和参考式两种

  • 行内式的链接:只要在方括号后面紧接着圆括号并插入网址链接或本地相对路径即可,链接之后还可以加上title文字,用双引号把title文字包起来即可
  • 参考式的链接:在链接的文字后面再接上另一个方括号,在第二个方括号内填入用以识别链接的标记,接着可以在文档的任意处,把这个链接内容定义出来
    参考式进一步简化书写,省去第二个方括号中的id,直接用第一个方括号中的an example代替标记,即为隐式链接

代码示例:
[Yandex](https://www.yandex.com)
行内式:
This is [an example](http://example.com/ "Title") inline link
[This link](http://example.net/) has no title attribute
参考式:
This is [an example][id] reference-style link
[id]: http://example.com/ "Optional Title Here"

自动链接:用方括号将网址链接或邮箱地址包起来即可

代码示例:
<https://baidu.com>

6. 列表

语法说明:
列表分为无序列表和有序列表,在行首使用*,+,-表示无序列表,使用数字和点表示有序列表

代码示例:
* 无序列表
+ 无序列表
- 无序列表
1\. 有序列表

7. 引用

语法说明:

使用>表示引用,在每一行最前面加上>或只在整个段落的第一行最前面加上>

代码示例:
> 引用文本行

嵌套引用:
根据层次加上不同数量> ,也可以在引用中使用其他Markdown语法,包括标题、列表、代码区块等

8. 行内代码

语法说明:
使用 `代码` 表示行内代码块

代码示例:
`hello world`

9. 插入图片

语法说明:
使用![描述](图片链接地址)插入图像

10. 内容目录

语法说明:
在段落中填写[TOC] 以显示全文内容的目录结构

代码示例:
[TOC]

11. 删除线

语法说明:
使用 ~~表示删除线,注意使用英文字符

代码示例:
~~删除此文本行~~

12. 分隔线

语法说明:
在一行中使用三个或以上的星号、减号或底线来建立一个分隔线,星号或减号之间可以插入空格

代码示例:
***
* * *

13. 引注

语法说明:
使用 [^keyword]表示引注

14. LaTex公式

语法说明:
$表示行内公式,$$表示整行公式

代码示例:
$E=mc^2$

参考资料https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference

15. 代码块

语法说明:
```开启代码语言类型选择

16. 流程图

语法说明:
```flow 开启流程图输入

参考资料:https://mermaidjs.github.io/flowchart.html

17. 甘特图

语法说明:
```gantt 开启甘特图输入

参考资料:https://mermaidjs.github.io/gantt.html

18. 表格

语法说明:
|表示单元格分割,---表示左对齐,---:表示右对齐,:---:表示居中对齐

19.To-do列表

语法说明:
使用带有[ ][x](未完成或已完成)项的列表语法撰写一个待办事宜列表,并且支持子列表嵌套以及混用Markdown语法

代码示例:
- [ ]待完成事项
- [x] 已完成事项

20. 插入普通符号

语法说明:
在以下符号前添加反斜杠\来插入符号

\\反斜线
\‘反引号
\* 星号
\_ 底线
\{ \}大括号
\[ \]方括号
\( \)括号
\# 井字号
\+ 加号
\-减号
\. 英文句号,小数点
\! 惊叹号

参考资料

[1] 作业部落 Cmd Markdown高阶语法手册

[2] 百度百科 markdown

[3] Markdown 语法说明 (简体中文版)

[4] Markdown: Syntax

[5] Markdown editing with Visual Studio Code

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

推荐阅读更多精彩内容

  • A、目录 1、斜体和粗体 2、分级标题 3、超链接3.1、行内式3.2、参考线3.3、自动链接 4、锚点 5、列表...
    侯工阅读 971评论 2 7
  • Markdown语法总结 一.标题 1. 两个= 或者两个- 对应1、2阶标题 对应效果: This is an ...
    WillBetterMan阅读 665评论 0 0
  • 因为在简书上写文章需要使用到MarkDown,但是我对MarkDown语法不熟,所以写下这一篇《MarkDown ...
    _执念__阅读 463评论 0 1
  • 目录 区块元素标题列表区块引用代码区块分隔线段落和换行 区段元素链接强调代码图片转义 标题 类SetextTh...
    ting723阅读 28,097评论 2 32
  • Markdown 简介 Markdown 是一种用来写作的轻量级标记语言, 用一些简单的标记, 来代替常见的排版格...
    高小原阅读 445评论 0 0