1 Markdown介绍
设计理念
- Markdown 易于阅读,方便创作web文档,利于各平台无缝分发。
- Markdown 语法灵感最大的来源还是纯文本 email 的格式,完全由标点符号标签组成的纯文本。
- Markdown 文件应该以纯文本形式原样发布,不应该包含标记标签和格式化指令。
内联 HTML 语法
- HTML 是一种发布格式,Markdown 是一种创作格式。
- Markdown语法集合比较小,只是HTML标签的一小部分。
- 对于 Markdown 中未包含的标签, 可以直接使用 HTML标签,例如用 HTML
<a>
标签替代 Markdown 的链接语法。
特殊字符自动转义
在 HTML 中, 有两个字符需要特殊对待: < 和 &,左尖括号用于起始标签。如果你想将它们用作字面量, 你必须将它们转义为字符实体, 例如< 和 &。
特殊字符以普通文本方式输出
在 markdown 中, 有些字符在某些场景下会被自动转义,例如< 和 &等,还有某些字符在某些场景下有特殊作用,如|在表格中,这时如果我们想要让这些字符原样展示,可使用\字符+要展示字符,这时就会单纯以文本的方式输出了。
2 注释
代码法
<div style='display: none'>
注释,不会在浏览器中显示。
</div>
html注释
既然支持html语法,那也支持html注释,快捷键 comment + /。
<!--我是注释,不会在浏览器中显示。-->
<!--
我是多段注释,
不会在浏览器中显示。
-->
hack方法
hack方法就是利用markdown的解析原理来实现注释的。一般有的markdown解析器不支持上面的注释方法,这个时候就可以用hack方法。hack方法比上面2种方法稳定得多,但是语义化太差。
[//]: # (我是最强注释,不会在浏览器中显示。)
[^_^]: # (我是最萌注释,不会在浏览器中显示。)
[//]: <> (我是注释,不会在浏览器中显示。)
[comment]: <> (我是注释,不会在浏览器中显示。)
3 分级标题
使用 = 和 - 分别标记一级和二级标题,数量最少一个
一级标题
==========
二级标题
----------
使用#加空格,共支持6级标题,几级标题使用几个#
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题 <!--最多6级标题-->
由于用了标记编辑器会把所有标题写到目录大纲中,在这里写的演示标题也会列进去,所以就不演示了。同学们自己在编辑器中观察,很简单,一级标题字号最大,依级递减。
4 段落格式
缩进
不同特殊占位符所占空白是不一样大的
- 全角
或
- 半角
或
- 半角之半角
或
演示
无缩进
半角之半角
半角
全角
换行
在文字的末尾使用两个或两个以上的空格来表示换行
// 注:第一行后有2个空格
第一行
第二行
演示
第一行
第二行
空行
在两行文字中间加一行空行即可(只要这一行只有回车或者space没有其他的字符就算空行)。
第一行
第二行
演示
第一行
第二行
对齐方式
<center>行中心对齐</center>
<p align="left">行左对齐</p>
<p align="right">行右对齐</p>
演示
行左对齐
行右对齐
分隔线
你可以在一行中用三个或三个以上的星号、减号、下划线来建立一条分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
- 表示行内公式
* * *
***
*****
- - -
-----------
演示
上半部分
下半部分
5 字体
粗体
- 在文字两端各加2个星
**
**粗体**
- 在文字两端各加2个下划线
__
__粗体__
演示
正常
粗体
斜体
- 在文字两端各加1个星
*
*斜体*
- 在文字两端各加1个下划线
_
_斜体_
演示
正常
斜体
粗斜体
- 在文字两端各加3个星
***
***粗斜体***
- 在文字两端各加3个下划线
___
___粗斜体___
演示
正常
粗斜体
删除线
在文字的两端各加2个波浪线 ~~
~~删除线~~
演示
正常
删除线
下划线
- 使用HTML的
<u>
标签
使用该方法有2个缺点:
a. HTML5 规范建议开发者尽量使用其他元素替代<u>
元素
b. u标签的下划线自定义程度低,只有黑色一种颜色
如果是简单使用,该方法足够了。但如果想定制化可以使用<span>
标签
<u>下划线</u>
- 使用HTML的
<span>
标签
在这里不过多介绍<span>
标签的用法,如有需要,请自行查阅资料
<span style="border-bottom:2px dashed red;">下划线</span>
演示
正常
下划线
下划线
背景高亮
- 在文字的两端各加2个等于号
==
==背景高亮==
- 使用
<mark>
标签
<mark>背景高亮</mark>
演示
正常
背景高亮
字体、字号、颜色
字体大小,字体颜色等常用配置使用 <font>
标签即可,这里不再赘述
<font face="黑体">我是黑体字</font>
<font face="微软雅黑">我是微软雅黑</font>
<font face="STCAIYUN">我是华文彩云</font>
<font color=#0099ff size=12 face="黑体">黑体</font>
<font color=gray size=5>gray</font>
<font color=#00ffff size=3>null</font>
演示
正常
我是黑体字
我是微软雅黑
我是华文彩云
<font color=#0099ff size=12 face="黑体">黑体
<font color=gray size=5>gray
<font color=#00ffff size=3>null
6 链接
超链接
- 行内式
语法说明:[]里写链接文字,()里写链接地址, ()中的""中可以为链接指定title属性,title属性可加可不加。title属性的效果是鼠标悬停在链接上会出现指定的 title文字,链接地址与title前有一个空格。
[高压锅里的小白](https://blog.baipengfei.com "高压锅里的小白")
演示
- 参考式
参考式超链接一般用在学术论文上面,或者另一种情况,如果某一个链接在文章中多处使用,那么使用引用 的方式创建链接将非常好,它可以让你对链接进行统一的管理。
语法说明: 参考式链接分为两部分,文中的写法 [链接文字][链接标记],在文本的任意位置添加[链接标记]:链接地址。
如果链接文字本身可以做为链接标记,你也可以写成[链接文字][]
[链接文字]:链接地址的形式,见代码的最后一行。
我经常去的几个网站[Google][1]、[百度][2]。
[1]:https://www.google.com
[2]:https://www.baidu.com
演示
注脚
语法说明: 在需要添加注脚的文字后加上脚注名字 [^注脚名字]
,称为加注。 然后在文本的任意位置(一般在最后)添加脚注,脚注前必须有对应的脚注名字。
使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2]。
[^1]:Markdown是一种纯文本标记语言
[^2]:HyperText Markup Language 超文本标记语言
注:
(1) 脚注会被自动搬运到最后面,请到文章末尾查看,脚注后方的链接可以直接跳转回到加注的地方。
(2) 经测试注脚与注脚之间必须空一行,不然会失效。成功后会发现,即使你没有把注脚写在文末,经Markdown转换后,也会自动归类到文章的最后。
锚点(页内超链接)
网页中,锚点其实就是页内超链接,也就是链接本文档内部的某些元素,实现当前页面中的跳转。比如我这里写下一个锚点,点击回到目录,就能跳转到目录。 在目录中点击这一节,就能跳过来。还有下一节的注脚。这些根本上都是用锚点来实现的,且只支持在标题后插入锚点,其它地方无效。
## 0. 目录{#index}
自动链接
语法说明: Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用<>包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:
<http://example.com/>
<address@example.com>
演示
http://example.com/
<address@example.com>
7 列表
无序列表
无序列表可以使用星号 *
、加号 +
或减号 -
作为列表标记,在这些标记后面要添加一个空格,然后再填写内容:
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
演示
- 第一项
- 第二项
- 第三项
有序列表
有序列表使用数字并加上点 .
来表示,标记后面也要添加一个空格,然后再填写内容
1. 第一项
2. 第二项
3. 第三项
演示
- 第一项
- 第二项
- 第三项
嵌套列表
列表嵌套只需在子列表中的选项前面添加四个空格即可:
1. 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
演示
- 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
- 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
定义型列表
语法说明: 定义型列表由名词和解释组成。一行写上定义,紧跟一行写上解释。解释的写法 :
紧跟一个缩进(Tab)
Markdown
: 轻量级文本标记语言(左侧有一个可见的冒号和四个不可见的空格)
演示
Markdown
: 轻量级文本标记语言(左侧有一个可见的冒号和四个不可见的空格)
任务列表
任务列表可以创建带有复选框的项目列表。在支持任务列表的Markdown应用程序中,复选框将显示在内容旁边。要创建任务列表,请在任务列表项之前添加破折号 -
和方括号 [ ]
,并在 [ ]
前面加上空格。要选择一个复选框,请在方括号 [x]
之间添加 x
。
// 格式`- + 空格 + [ ]`
- [ ] 任务一 未做任务
// 格式`- + 空格 + [x]`
- [x] 任务二 已做任务
演示
- 任务一 未做任务
- 任务二 已做任务
8 图像
格式:![图片Alt](图片地址 "图片Title")
说明:
- 图片Alt:如果图片因为某些原因不能显示,就用定义的图片Alt文字来代替图片。
- 图片地址:跳转链接
- 图片Title:图片Title则和链接中的Title一样,表示鼠标悬停与图片上时出现的文字。
注:Alt 和 Title 都不是必须的,可以省略,但建议写上。
<center> <!--开始居中对齐-->
![GitHub set up](http://zh.mweb.im/asset/img/set-up-git.gif "图片Title")
</center> <!--结束居中对齐-->
9 多级引用
引用需要在被引用的文本前加上>符号和空格,允许多层嵌套,也允许你偷懒只在整个段落的第一行最前面加上 >
>>> 请问 Markdwon 怎么用? - 小白
>> 自己看教程! - 愤青
> 教程在哪? - 小白
演示
教程在哪? - 小白
自己看教程! - 愤青
请问 Markdwon 怎么用? - 小白
10 转义字符
由于Markdown自身是有格式要求的,例如# * < 等字符都是格式化字符,所以如果想直接以文本显示这些字符的话需要进行处理,处理方式有以下几种:
使用反斜线 \
(推荐)
\<span>
Markdown为以下字符提供反斜杠转义:
符号 | 含义 |
---|---|
\ | 反斜杠 |
` | 反引号 |
* | 星号 |
_ | 下划线 |
{} | 大括号 |
[] | 中括号 |
() | 小括号 |
# | 井号 |
+ | 加号 |
- | 减号 |
. | 英文句号 |
! | 感叹号 |
<em>
标签
<em>*literal asterisks*</em>
Html ASCII转义
<转义>
常用转义字符:
特殊字符 | 描述 | 字符的代码 |
---|---|---|
空格符 | | |
< | 小于号 | < |
> | 大于号 | > |
& | 和号 | & |
¥ | 人民币 | ¥ |
© | 版权 | © |
® | 注册商标 | ® |
°C | 摄氏度 | °C |
± | 正负号 | ± |
× | 乘号 | × |
÷ | 除号 | ÷ |
² | 平方(上标²) | ² |
³ | 立方(上标³) | ³ |
| | 竖线,在表格中展示时可使用,平时无需使用 | | |
演示
1、使用 /
<span>
2、使用 <em>
literal asterisks
3、使用ASCII转义
<转义>
11 目录
在段落中填写 [TOC] 以显示全文内容的目录结构。
[TOC]
12 代码块
对于程序员来说这个功能是必不可少的,插入程序代码的方式有两种,一种是利用缩进(Tab), 另一种是利用`符号(一般在ESC键下方)包裹代码。
行内式
C语言里的函数 `scanf()` 怎么使用?
缩进式(多行代码)
缩进 4 个空格或是 1 个制表符
一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。
#include <stdio.h>
int main(void)
{
printf("Hello world\n");
}
用六个`包裹多行代码
、、、
include <stdio.h>
int main(void)
{
printf("Hello world\n");
}
、、、
13 Mermaid
Mermaid 是一个基于 JavaScript 的图表绘制工具,它使用 Markdown 启发的文本定义和渲染器来创建和修改复杂的图表。
具体使用请见官方文档,不过官方文档没有中文,需要中文可以看Mermaid中文网
14 表格
格式说明:
- 第一行为表头
- 第二行分隔表头和主体部分
- 第三行开始每一行为一个表格行
列于列之间用管道符|
隔开,原生方式的表格每一行的两边也要有管道符。
第二行还可以为不同的列指定对齐方向。默认为左对齐,在-右边加上:就右对齐。
语法 | 说明 |
---|---|
- | 左对齐 |
:-: | 中心对齐 |
-: | 右对齐 |
|学号|姓名|序号|
|-|-|-|
|小明明|男|5|
|小红|女|79|
|小陆|男|192|
演示
左对齐:
学号 | 姓名 | 序号 |
---|---|---|
小明明 | 男 | 5 |
小红 | 女 | 79 |
小陆 | 男 | 192 |
中心对齐:
学号 | 姓名 | 序号 |
---|---|---|
小明明 | 男 | 5 |
小红 | 女 | 79 |
小陆 | 男 | 192 |
右对齐:
学号 | 姓名 | 序号 |
---|---|---|
小明明 | 男 | 5 |
小红 | 女 | 79 |
小陆 | 男 | 192 |
15 HTML 原始码
在代码区块里面, & 、 < 和 > 会自动转成 HTML 实体,这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码,只需要复制贴上,剩下的 Markdown 都会帮你处理。
- 表示整行公式
第一个例子:
<div class="footer">
© 2004 Foo Corporation
</div>
第二个例子:
<center>
<table>
<tr>
<th rowspan="2">值班人员</th>
<th>星期一</th>
<th>星期二</th>
<th>星期三</th>
</tr>
<tr>
<td>李强</td>
<td>张明</td>
<td>王平</td>
</tr>
</table>
</center>
演示
第一个例子:
第二个例子:
值班人员 | 星期一 | 星期二 | 星期三 |
---|---|---|---|
李强 | 张明 | 王平 |
评论区