[手册] - Markdown 语法

准备阶段

Markdown 是程序员书写文档的语言,普通用户也可以学习 Markdown 的语法编写清晰、美观的文档,学习的成本极低。

不需要任何额外的工具,一个 Markdown 文档甚至可以使用 Window 系统自带的文本文档创建,只要将 .txt 结尾改为 .md 即可,以 .md 为后缀的文件,即 Markdown 文本,将 Markdown 文本通过支持 Markdown 语法的编辑器打开才能看到实际的效果。

IDCE 的编辑器提供了实时预览的功能,可以作为 Markdown 的学习工具。

Markdown 语法

标题(这个就是标题)

标题是一类加黑加粗的字体,并且带有分割线,独占一行,常用于文档的章节部分,在 Markdown 语法中,# 井号后面的即为一个标题。

# 一级标题
## 二级标题
### 三级标题

其中,# 号后面需要跟随一个空格,如果 # 号与文字之间没有空格则不会被解析成 Markdown 语法;标题需要单独成行,并且前面不能有其他文字,即 # 号必须置于行首;# 号代表标题的级数,可以理解为 html 标签中的 h1~h6,井号代表了标题的级数,级数越大字体越小。

效果如下:

image.png

换行

在 Markdown 语法中,换行需要输入两次回车。

高亮

使用 ==高亮字体== 来显示高亮字体。

示例:高亮字体

粗体字

粗体字是将文字转化为粗体,可以理解为 HTML 中的 <b></b> 标签。

粗体字使用 **粗体字** 两个星号将需要转化为粗体的字包围起来,如:我是粗体

在 IDCE 的编辑器中,可以用鼠标选中需要加粗的字,然后按快捷键 Ctrl+b 将文字转化为粗体字。

斜体

使用单个 * 星号将文字转化为斜体字,如:*斜体字*,实际效果为:

斜体字

使用三个 * 星号将文字转化为斜体加粗字,如 ***斜体加粗字***,实际效果为:

斜体加粗字

删除线

使用两个波浪线将文字转化为删除线文字,如 ~~删除线~~,实际效果为:

删除线

引用

引用即引用名人、其他文档的文字,如下所示:

不会 Markdown 的程序员不是好程序——鲁迅

使用 > 引用内容 展示一段引用效果,引用需要置于行首。

> 不会 Markdown 的程序员不是好程序——鲁迅
>> 我没说过!——鲁迅
>>> 是我说的。——高尔基

使用多个 > 右尖括号可以实现多级引用效果。

不会 Markdown 的程序员不是好程序——鲁迅

我没说过!——鲁迅

是我说的。——高尔基

分割线

三个或者三个以上的 * 星号或者 - 横杠表示一条分割线。

---
***

展示效果:


插入图片

使用下面的语法插入一张图片:

![图片名称](图片链接地址)

例如:

![image.png](https://i.loli.net/2019/08/21/HpldVsi1mU8XjZA.png)

在 IDCE 的编辑器中,可以 Ctrl+c 复制一张图片,然后返回编辑器 Ctrl+v 粘贴,实现快速添加图片;此外还可以使用工具栏中的图片上传选择对应的图片。

如果使用某些截图工具,如 QQ 截图、微信截图,在完成截图后,同样可以使用 Ctrl+v 将图片粘贴至编辑器中。

注!上传图片需要花费一定的时间,最大支持 5M

超链接

使用如下语法添加超链接:

[超链接文字](链接地址)

如:

[IDCE.com](https://idce.com)

显示效果为:

IDCE.com

注意!超链接不支持在新页面打开

列表

列表分为两种,其中一种为无序列表,即没有序号的列表,另一种是有序列表,每一项会按照1、2、3的顺序罗列下来。

无序列表

使用 -+* 创建一个无序列表:

- 皮卡丘
- 喵喵
- 火球鼠

显示效果:

  • 皮卡丘
  • 喵喵
  • 火球鼠

上面也可以替换成:

* 皮卡丘
* 喵喵
* 火球鼠

+ 皮卡丘
+ 喵喵
+ 火球鼠

有序列表

数字加上 . 后面跟一个空格,即可生成一个有序列表:

1. PHP
2. MySQL
3. Redis

显示效果:

  1. PHP
  2. MySQL
  3. Redis

列表嵌套
上级与下级直接间隔三个空格:

- PHP
   - 变量
   - 条件控制
   - 循环
- MySQL
   - SELECT 查询
   - 聚合函数
- Redis
  1. 字符串
  2. 集合
  3. 哈希 

显示效果:

  • PHP
    • 变量
    • 条件控制
    • 循环
  • MySQL
    • SELECT 查询
    • 聚合函数
  • Redis
    1. 字符串
    2. 集合
    3. 哈希

表格

使用如下语法即可创建一个表格:

表头|表头|表头
---|:--:|---:
内容|内容|内容 
内容|内容|内容

表格效果:

名称 价格 备注
苹果 5块/斤 进口苹果
栗子 10块/斤

代码块

代码块分为两种,一种是插入到文字当中的,如 code 即为一个代码块,这种代码使用 ` 号将需要转化为代码块的文字包围起来即可:

`code`

上面的也是一个代码块,这种代码块会单独占据一行(或者多行),使用三个 ` 将需要转化为代码块的文字包含起来,如:```代码块```

转义字符

有时候希望输出 * 号之类的一些被 Markdown 占用的字符,如上面的:```代码块```,这个时候就需要使用转义字符。

转义字符使用 \ 斜杠表示,如下所示:

- 列表

上面的语法会被解析成无序列表,如果只希望显示文本,可以加上转义字符,如下:

\- 列表

显示效果:

- 列表

这样就不会被解析了。

有时候,转义字符 \ 斜杠不起作用,这个时候可以使用另一种方法,使用 HTML 实体,下面只列出部分 HTML 实体对照表:

符号 HTML 实体
> &gt;
< &lt;
* &#42;
/ &#47;
" &quot;

由于 HTML 实体较多,故无法在此一一罗列出来,如有兴趣可以自行搜索。

复选框

复选框即一种是否勾选的方框。

- [x] 已选中
- [ ] 未选中

示例:

  • 已选中
  • 未选中

脚注

脚注是附在文章页面的最底端的,对某些东西加以说明的注文,如毕业论文中引用出处,需要在引用内容加上脚注来标注来源信息。

这是一个脚注[1],点击右上角的[1]后可以跳转到底部的引用信息。

脚注可以插入到文章正文的位置:

# [^脚注ID]
这是一段文字[^2]。

# [^脚注ID]: 脚注描述
[^2]: ID 为 2 的脚注说明文字

示例:

这是一段文字[2]


  1. 脚注内容 ↩︎

  2. ID 为 2 的脚注说明文字 ↩︎

讨论

还没有人评论~