JS Guide JS Guide
首页
  • JS 部分
  • HTML 部分
  • CSS 部分
  • Vue
  • React & Angular
  • 数据结构、算法、OS
  • 计网、浏览器
  • 杂项
笔试
面试
资源
资讯
  • 关于本站
  • 更新历史
  • 贡献指南
  • 文档规范
  • 常见问题
GitHub (opens new window)
首页
  • JS 部分
  • HTML 部分
  • CSS 部分
  • Vue
  • React & Angular
  • 数据结构、算法、OS
  • 计网、浏览器
  • 杂项
笔试
面试
资源
资讯
  • 关于本站
  • 更新历史
  • 贡献指南
  • 文档规范
  • 常见问题
GitHub (opens new window)
  • 文档规范说明
  • 中文排版规范
  • 代码规范
  • Markdown 规范

    • Markdown 规范
    • Markdown 基本语法
      • 1 标题
      • 2 字体
      • 3 引用
      • 4 分割线
      • 5 HTML
      • 6 超链接
      • 7 图片
      • 8 列表
      • 9 代码
      • 10 数学公式
      • 11 任务列表(Todo List)
      • 12 表格
      • 13 转义字符
      • 参考资料
    • 在 VuePress 中使用 Markdown
  • 文档规范
  • Markdown 规范
卡洛
2022-10-23
目录

Markdown 基本语法

Markdown 是一种纯文本格式标记语言,它通过简单的标记语法实现了格式排版,且易学、易读、易写,因此非常流行。

常用编辑器:

  • Typora
  • VS Code

# 1 标题

标题文字前面加 # 即可,注意 # 与文字之间要有空格。几级标题加几个 #,共有六级标题。例如本段落标题的源码为:

## 1 标题
1

# 2 字体

# 2.1 粗体

使用 ** 或 __ 包在文字两端。例如:**粗体** 效果为 粗体。

# 2.2 斜体

使用 * 或 _ 包在文字两端。例如:*斜体* 效果为 斜体。

当然,粗体斜体可以嵌套使用,例如:***粗体+斜体*** 效果为 粗体+斜体。

# 2.3 高亮

使用 == 包在文字两端。例如:==高亮== 效果为 ==高亮==。

提示

== 是 Markdown 原生的表示高亮的语法,但 Typora 需要设置才可开启。

此外,可以使用 HTML5 的 <mark> 标签来表示高亮,例如:<mark>高亮</mark> 效果为 高亮。

# 2.4 删除线

使用 ~~ 包在文字两端。例如:~~删除线~~ 效果为 删除线。

# 3 引用

引用文字前面加>即可。引用可以嵌套,使用>>、>>>……以此类推。

例如:

> 一级引用
>> 二级引用
>>>>> 五级引用
> > >
> 回退到三级引用
>
> 回退到一级引用
1
2
3
4
5
6
7

效果为

一级引用

二级引用

五级引用

回退到三级引用

回退到一级引用

# 4 分割线

三个或三个以上的 - 或 *(Typora 还支持 +)。

例如:

---
-----
***
*****
1
2
3
4

效果为





# 5 HTML

直接输入即可,会自动渲染。例如:<b>HTML 加粗</b> 效果为 HTML 加粗。再例如:

<font face="黑体" size="5" color="red">HTML 内容</font>
1

效果为

HTML 内容

甚至可以来段更复杂的:

<form>
用户名: <input type="text" name="user"><br>
密 码: <input type="password" name="pwd"><br>
性 别: <input type="radio" name="sex" value="男" checked>男&nbsp;
    <input type="radio" name="sex" value="女">女<br>
<button type="button" name="Submit" onclick="alert('成功')">提交</button>
<button type="reset" name="Reset">重置</button>
</form>
1
2
3
4
5
6
7
8

效果为

用户名:
密 码:
性 别: 男  女

(点一下试试)

# 6 超链接

使用 [name](link "tooltip") 表示超链接,其中 name 是超链接文字,link 是超链接地址,tooltip 是悬浮文字提示(可选)。

例如:

[JS Guide](https://jsguide.cn "你好")
1

效果为

JS Guide (opens new window)

还可以用 HTML 的 a 标签,例如:

<a href="https://jsguide.cn" target="_blank">JS Guide</a>
1

效果为

JS Guide

其中 target="_blank" 表示在新标签打开。

当遇到纯链接时,可以用 < 和 > 将其包起来,防止解析错误,例如:

<https://jsguide.cn/>这是包起来的效果
https://jsguide.cn/这是不包起来的效果
1
2

https://jsguide.cn/ (opens new window)这是包起来的效果

https://jsguide.cn/这是不包起来的效果

# 7 图片

使用 ![text](link "tooltip") 表示图片,其中 text 是图片说明,link 是图片路径,可以用相对路径、绝对路径、互联网路径,tooltip 是悬浮文字提示(可选)。

例如(互联网路径):

![JS Guide](https://cdn.jsdelivr.net/gh/kaluojushi/Corecabin-Picbed/img/jsguide-homepage.png "JS Guide 主页")
1

效果为

JS Guide

以及套娃设置图片的超链接,例如(相对路径):

[![JS Guide](/assets/homepage.png)](https://jsguide.cn)
1

效果为:

JS Guide (opens new window)

# 8 列表

# 8.1 无序列表

文字前面加 - 或 * 或 + 即可,注意符号与文字之间要有空格。

例如:

- 无序列表 1
* 无序列表 2
+ 无序列表 3
1
2
3

效果为

  • 无序列表 1
  • 无序列表 2
  • 无序列表 3

# 8.2 有序列表

文字前面加数字与 . 即可,注意符号与文字之间要有空格。注意显示效果与实际输入数字无关,而与当前次序有关。

例如:

1. 第一点
2. 第二点
4. 大概是第四点?
1
2
3

效果为

  1. 第一点
  2. 第二点
  3. 大概是第四点?

# 8.3 列表嵌套

不同级列表之间通过缩进即可嵌套,例如:

- 一级无序
	+ 二级无序 1
	+ 二级无序 2
1. 一级有序
	1. 二级有序
		+ 三级无序
1
2
3
4
5
6

效果为

  • 一级无序
    • 二级无序 1
    • 二级无序 2
  1. 一级有序
    1. 二级有序
      • 三级无序

# 9 代码

# 9.1 行内代码

使用 ` 包在代码两端。例如:

`javascript`
1

效果为

javascript

本文也大量用到行内代码表示文字高亮。

# 9.2 代码块

使用 ``` 包在代码两端,第一行可以加入代码语言,例如:

```javascript
function fact(num) {
  if (num === 1) {
    return 1;
  }
  else {
    return num * fact(num - 1);
  }
}
```
1
2
3
4
5
6
7
8
9
10

效果为

function fact(num) {
  if (num === 1) {
    return 1;
  }
  else {
    return num * fact(num - 1);
  }
}
1
2
3
4
5
6
7
8

本文也大量用到代码块表示 Markdown 示例。

提示

如果代码块中嵌套了代码块,外层代码块可以使用 ```` 包起来。

# 10 数学公式

Markdown 支持 LaTeX 公式。行内公式用 $ 包在公式两端,公式块用 $$ 包在公式两端,例如:

当 $a \ne 0$, 此方程式有两个解 $ax^2 + bx + c = 0$,他们是
$$
x = {-b \pm \sqrt{b^2-4ac} \over 2a}.
$$
1
2
3
4

提示

Typora 需要设置开启行内公式。

VuePress 需要安装插件 vuepress-plugin-mathjax (opens new window)。

# 11 任务列表(Todo List)

文字前面加- [ ]或- [x]即可,空格表示未完成,x表示已完成。

例如:

- [x] 甜甜圈
- [x] 珍珠奶茶
- [ ] 方便面
- [x] 火锅
- [ ] 米饭
- [ ] 大盘鸡
1
2
3
4
5
6

提示

VuePress 需要安装插件或主题的支持。

# 12 表格

语法为:

表头|表头|表头
---|---|---
内容|内容|内容
内容|内容|内容
1
2
3
4

第二行用来分割表头与内容。- 的个数有一个就行,此处多加了几个。

文字默认居左。- 的两边加 : 表示该列居中,- 的右边加 : 表示该列居右。

例如:

姓名(居左)|年级(居中)|年龄(居右)
-----|:-----:|-----:
张三|大三|21
李四|大一|18
王五|研二|24
1
2
3
4
5

效果为

姓名(居左) 年级(居中) 年龄(居右)
张三 大三 21
李四 大一 18
王五 研二 24

# 13 转义字符

在输入特殊符号,尤其是 Markdown 和 HTML 中的部分符号时,可以使用转义字符。

# 13.1 Markdown 转义字符

使用 \ 置于符号前。

例如输入 *你好* 会显示 你好,输入 \*你好\* 效果为 *你好*。

具体如下:

字符 含义 转义字符
\ 反斜杠 \\
` 反引号 \`
* 星号 \*
_ 下划线 \_
{} 花括号 \{\}
[] 方括号 \[\]
() 小括号 \(\)
# 井号 \#
+ 加号 \+
- 减号 \-
. 英文句点 \.
! 英文感叹号 \!

# 13.2 HTML 转义字符

直接输入 HTML 转义字符,具体如下:

显示结果 描述 输入 实体编号
空格 &nbsp; &#160;
< 小于号 &lt; &#60;
> 大于号 &gt; &#62;
& 和号 &amp; &#38;
" 引号 &quot; &#34;
' 撇号 &apos;(IE不支持) &#39;
¢ 分 &cent; &#162;
£ 镑 &pound; &#163;
¥ 日圆 &yen; &#165;
§ 节 &sect; &#167;
© 版权 &copy; &#169;
® 注册商标 &reg; &#174;
× 乘号 &times; &#215;
÷ 除号 &divide; &#247;

# 参考资料

  • Markdown基本语法 - 简书 (opens new window)
  • Markdown基本语法与示例 (opens new window)
在 GitHub 中编辑此页 (opens new window)
上次更新于: 2022/10/25 00:52:37
Markdown 规范
在 VuePress 中使用 Markdown

← Markdown 规范 在 VuePress 中使用 Markdown→

Theme by Vdoing | Copyright © 2022-2022 Carlo | Powered by VuePress
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式