Markdown 基本语法

简介

  • Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
  • Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  • Markdown 编写的文档后缀为 .md, .markdown

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、知乎等。

本文使用 Typora 编写,它支持 MacOS 、Windows、Linux 平台,且包含多种主题,编辑后直接渲染出效果。支持导出 HTML、PDF、Word、图片等多种类型文件。

Tips:本文 markdown 语法在简书渲染有一些问题。可以下载 markdown 编辑器或在线编辑器进行学习。

以下内容参考 Markdown Guide 进行整理。

标题

# h1
## h2
### h3
#### h4
##### h5
###### h6

Header 1
========

Header 2
--------

效果:

标题

为了不影响排版,这里使用图片。

强调

*italic*
_italic_
**bold**
__bold__
`code`

效果:

italic
italic
bold
bold
code

列表

无序列表使用星号(*****)、加号(+)或是减号(-)作为列表标记

* Item 1
* Item 2

+ Item 1
+ Item 2

- Item 1
- Item 2

效果:

  • Item 1
  • Item 2
  • Item 1
  • Item 2
  • Item 1
  • Item 2

有序列表使用数字并加上 . 号来表示

1. Item 1
2. Item 2

效果:

  1. Item 1
  2. Item 2

列表嵌套

- Item 1
  - Item 1

效果:

  • Item 1
    • Item 1

待办事宜 Todo 列表

- [ ] Update the website
- [x] Write the press release

效果:

任务列表

这里在简书的渲染效果有问题,直接贴图片

链接

链接使用方法如下:

[Link name](path)

<path>

效果:

link

https://www.jianshu.com/u/3f644e66afa3

添加标题

[Link name](https://www.jianshu.com/u/3f644e66afa3 "title")

鼠标悬停链接上,查看效果:

我的简书

其他操作

通过变量来设置一个链接,变量赋值在文档末尾进行:

[lio][blog]
[blog]: https://www.jianshu.com/u/3f644e66afa3

效果:

通过变量来设置一个链接

简书编辑器所呈现的效果跟 typora 不一样,这里直接贴图片

图片

![Image alt text](/path/to/img.jpg)
显示图片

添加标题

![Image alt text](img.jpg "title")
添加标题

直接使用 <img /> 标签

<img src="path" />

代码

使用 ``` 包裹一段代码,并指定一种语言(也可以不指定)

代码

效果:

code fences
console.log('代码块')

区块引用

Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号

> 这是一个区块引用

效果:

这是一个区块引用

另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推

> 最外层
> > 第一层嵌套

效果:

最外层

第一层嵌套

分割线

使用三个以上的星号、减号、底线生成一个分隔线

----

****

___

效果:




删除线

使用两个波浪线 ~~ 来添加删除线

~~该内容已不再最新版本中使用~~

效果:

该内容已不再最新版本中使用

下划线

<u>带下划线文本</u>

效果:

<u>带下划线文本</u>

脚注

脚注是对文本的补充说明。

一段文字[^info]

效果:

脚注

内容目录

[TOC]

内容目录

这里在简书的渲染效果有问题,直接贴图片

表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

| Column 1 Heading | Column 2 Heading |
| ---------------- | ---------------- |
| Some content     | Other content    |

Column 1 Heading | Column 2 Heading
--- | ---
Some content | Other content

效果:

Column 1 Heading Column 2 Heading
Some content Other content
Column 1 Heading Column 2 Heading
Some content Other content

对齐方式:

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。
| Column 1 Heading | Column 2 Heading | Column 2 Heading |
| :---------------- | :----------------: | ----------------: |
| Some content     | Other content    | Other content |

效果:

Column 1 Heading Column 2 Heading Column 2 Heading
Some content Other content Other content

使用表情符号短代码🌐

使用开始和结束与冒号 :,并包括表情符号的名称。

Gone camping! :tent: Be back soon.

That is so funny! :joy:

效果:

Gone camping! ⛺️ Be back soon.

That is so funny! 😂

你可以在下面这些网站上找到所有可用的 Emoji:

更多资料

Typora 画流程图、时序图(顺序图)、甘特图 来自菜鸟教程的 Markdown 高级技巧中的一篇笔记


本文首发 blog,如果喜欢或者有所启发,欢迎 Star,对作者也是一种鼓励。

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

推荐阅读更多精彩内容

  • 1. 标题 Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。 类 Setext 形式是...
    Eva3288阅读 405评论 0 0
  • 标题 类Setext This is an H1 This is an H2 Code: Thisisan H1 ...
    月上心头花满西楼阅读 262评论 0 0
  • Markdown语法 当前文档仅用作个人学习笔记,来源: Markdown 中文文档 概述设计理念Markdown...
    DragonsLong阅读 3,450评论 1 2
  • Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,在2004由约翰·格鲁伯(英语...
    pshawn阅读 417评论 0 1
  • 前言 笔者最近想找一个博客来记载一些web开发方面的知识,偶然发现简书的体系甚好,并且完美支持富文本和markdo...
    强壮的埃尔维斯阅读 979评论 0 1