一份简单的Markdown指南

温馨提示：本文最后更新于2024.9.7 21:15，若内容或图片失效，请在下方留言或联系博主。

摘要

心中无尘，码字入神

Markdown 简介

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档.
Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建.
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档.
Markdown 编写的文档后缀为 .md, .markdown.

Markdown 应用

Markdown 能被使用来撰写电子书,如:Gitbook.
当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息.例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge 等.
相同的, Ited 博客也支持 Markdown (部分支持).

编辑器

本教程将使用 Ited 博客原生编辑器来讲解 Markdown 的语法, 原生编辑器不支持的语法将使用 Typora.

Markdown 标题

Markdown 标题有两种格式.

使用 = 和 - 标记一级和二级标题

= 和 - 标记语法格式如下,需要至少三个,中间可以有空格:

我展示的是一级标题
===

我展示的是二级标题
---

效果如下:

使用 # 号标记

使用 # 号可表示 1-6 级标题，一级标题对应一个 # 号，二级标题对应两个 # 号，以此类推.

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果如下:

为了观感,我们会把所有一级标题渲染为二级标题.

Markdown 段落

Markdown 段落没有特殊的格式，直接编写文字就好，段落的换行是使用两个以上空格加上回车.

这点不受 Ited 博客支持

当然也可以在段落后面使用一个空行来表示重新开始一个段落.

字体

Markdown 可以使用以下几种字体:

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

显示效果如下所示:

分隔线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西.你也可以在星号或是减号中间插入空格.下面每种写法都可以建立分隔线:

***
* * *
*****
- - -
----------

显示效果如下所示:

删除线

如果段落上的文字要添加删除线，只需要在文字的两端加上两个波浪线 ~~ 即可，实例如下:

中国共产党万岁!
中华人民共和国万岁!
~~帝国主义~~

显示效果如下所示:

下划线

下划线可以通过 HTML 的 <u></u> 标签来实现:

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

显示效果如下所示:

脚注

这点不受 Ited 博客支持

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

Markdown 脚注的格式如下:

[^要注明的文本]

以下实例演示了脚注的用法:

创建脚注格式类似这样 [^中华人民共和国].

[^中华人民共和国]: 工人阶级领导的以工农联盟为基础的人民民主专政的社会主义国家

演示效果如下:

Markdown 列表

Markdown 支持有序列表和无序列表.

在 ited 博客里,有序列表与无序列表渲染样式相同


图像

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记，这些标记后面要添加一个空格，然后再填写内容:

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项

显示结果如下:

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

1. 第一项
2. 第二项
3. 第三项

显示结果如下:

列表嵌套只需在子列表中的选项前面添加两个或四个空格即可:

1. 第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

显示结果如下:

Markdown 区块

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

> 中华人民共和国
> 我国的国体是工人阶级领导的以工农联盟为基础的人民民主专政的社会主义国家;
> 我国的政体是以民主集中制为组织原则和活动原则的人民代表大会制度.

在 ited 博客中,你也可以这样写:

> 中华人民共和国
我国的国体是工人阶级领导的以工农联盟为基础的人民民主专政的社会主义国家;
我国的政体是以民主集中制为组织原则和活动原则的人民代表大会制度.

显示结果如下:

区块里面可以书写任意 Markdown 代码,套娃是被允许的.

如果要在列表项目内放进块，那么就需要在 > 前添加四个空格的缩进.

列表中使用区块实例如下:

1. 中华人民共和国
  1. 国体
    > 工人阶级领导的以工农联盟为基础的人民民主专政的社会主义国家;
  2. 政体
    > 以民主集中制为组织原则和活动原则的人民代表大会制度.

显示结果如下:

Markdown 代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`)，例如:

`sudo rm -rf /` 是一条 shell 命令

显示结果如下:

代码区块使用 4 个空格或者一个制表符(Tab 键),每行都要缩进

实例如下:

    $(document).ready(function () {
        alert('人民万岁!');
    });

显示结果如下:

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

显示结果如下:

Markdown 链接

链接使用方法如下:

[链接名称](链接地址)

或者

<链接地址>

例如:

这是一个链接 [中国政府网_中央人民政府门户网站 (www.gov.cn)](https://www.gov.cn/ )

显示结果如下:

直接使用链接地址:

<https://www.gov.cn/>

显示结果如下:

我们可以通过变量来设置一个链接，变量赋值在文档末尾进行:

这个链接用 1 作为网址变量 [中国政府网\_中央人民政府门户网站\ (www.gov.cn)][1]
这个链接用 ited 作为网址变量 [ited][ited]
然后在文档的结尾为变量赋值(网址)

  [1]: https://www.gov.cn/
  [runoob]: https://itedev.com/

ited 博客仅支持数字变量

显示结果如下:

Markdown 图片

Markdown 图片语法格式如下:

![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")

开头一个感叹号 !
接着一个方括号，里面放上图片的替代文字
接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上选择性的 'title' 属性的文字.

使用实例:

![Cat is sleeping.](https://static.itedev.com/%40/public/images/cat/cat-is-sleeping.gif)

![Cat is sleeping.](https://static.itedev.com/%40/public/images/cat/cat-is-sleeping.gif "Cat is sleeping.")

显示结果如下:

当然，你也可以像网址那样对图片网址使用变量:

![Cat is sleeping.][1]

[1]: https://static.itedev.com/%40/public/images/cat/cat-is-sleeping.gif

显示结果如下:

Markdown 还没有办法指定图片的高度与宽度，如果你需要的话，你可以使用普通的 <img> 标签.

<img src="https://static.itedev.com/%40/public/images/cat/cat-is-sleeping.gif" width="50%">

显示结果如下:

Markdown 表格

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

语法格式如下:

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

显示结果如下:

我们可以设置表格的对齐方式:

-: 设置内容和标题栏居右对齐.
:- 设置内容和标题栏居左对齐.
:-: 设置内容和标题栏居中对齐.

实例如下:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

显示结果如下:

Markdown 高级技巧

HTML 元素

不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写,如:

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

显示结果如下:

转义

Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠转义特殊字符:

**文本加粗** 
\*\* 正常显示星号 \*\*

显示结果如下:

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

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

公式

由于渲染公式的文件体积过大,引入会影响性能,这点不受 Ited 博客支持

网页一般使用 KaTeX 或者 MathJax 来渲染数学表达式.

KaTeX 拥有比 MathJax 更快的性能，但是它却少了很多 MathJax 拥有的特性.你可以查看 Supported Functions · KaTeX 来了解 KaTeX 支持哪些符号和函数.

默认下的分隔符:

$...$ 或者 $...$ 中的数学表达式将会在行内显示.
$...$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示.

\begin{Bmatrix}
   a & b \\
   c & d
\end{Bmatrix}
$$
$$
\begin{CD}
   A @>a>> B \\
@VbVV @AAcA \\
   C @= D
\end{CD}

显示结果如下:

关于作图的内容暂不描述,文章篇幅已经很长了.

标签：开发 markdown 笔记