Skip to content

Markdown 基础

Markdown文档排版简单,直接可以当作文本文件编辑,使用任何文本编辑器,支持原生 HTML 语法,可以内联嵌入样式。

编辑器

建议使用vscode即可,其他专业编辑器或者好用的基本都是收费情况,例如Typora等。

1 安装vscode

连览器搜索 vscode或直接打开 https://code.visualstudio.com/,或者点击vscode打开,下载系统可用安装包双击打开根据引导进行安装。

2 安装扩展

打开扩展项,搜索插件,如下示例:

中文语言包

中文语言包

名称: Chinese (Simplified) (简体中文) Language Pack for Visual Studio Code
ID: MS-CEINTL.Code-language-pack-zh-hans
说明: Language pack extension for Chinese (Simplified)
版本: 1.85.2024021409
发布者: Microsoft

编辑器插件

注意 vscode 本身支持Markdown文件预览,可以不安装下面编辑器插件(有菜单栏也不是那么方便)

名称: Office Viewer(Markdown Editor)
ID: cweijan.Code-office
说明: View word,excel files and using WYSIWYG editor for markdown.
版本: 3.3.9
发布者: Weijan Chen
VS Marketplace 链接: https://marketplace.visualstudio.com/items?itemName=cweijan.Code-office

基础语法教程

2.1 标题

不同数量的 #可以完成不同的标题,例如:

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

2.2 字体

粗体、斜体、粗体和斜体,需要在文字前后加不同的标记符号。如下:

**这个是粗体**
*这个是斜体*
***这个是粗体加斜体***

注:如果想给字体换颜色、设置大小或者居中显示,需要使用内嵌HTML来实现

<p style="font-size: 20px;font-weight: bold;color: red;">16号红色加粗文字段落</p>
<span style="font-size: 20px;font-weight: bold;color: red;">16号红色加粗段落内容</span>
<center>居中</center>
<center><span style="font-size: 20px;font-weight: bold;color: red;">居中16号红色加粗段落内容</span></center>

示例1:

上一段落

16号红色加粗文字段落

下一段落

示例2: 当前段落前部分内容16号红色加粗段落内容当前段落后部分内容

示例3:

2.3 主动换行

通常使用回车换行即可,但想多行使用HTML换行标注一个或多个:</br>

2.4 无序列表

无序列表的使用,在符号 -后加空格使用,在符号 -前使用空格可控制列表的层级。如下:

- 无序列表 1
- 无序列表 2
  - 无序列表 2.1
  - 无序列表 2.2

结果如下:

  • 无序列表 1
  • 无序列表 2
    • 无序列表 2.1
    • 无序列表 2.2

2.5 有序列表

有序列表的使用,在数字及符号 .后加空格后输入内容,如下:

1. 有序列表 1
2. 有序列表 2
3. 有序列表 3

结果如下:

  1. 有序列表 1
  2. 有序列表 2
  3. 有序列表 3

2.6 引用

引用的格式是在符号 > 后面书写文字。如下:

> 读一本好书,就是在和高尚的人谈话。 ——歌德

结果如下:

读一本好书,就是在和高尚的人谈话。 ——歌德

2.7 链接 & 引用式链接

链接的格式是在符号 []内写写文字,后跟着 ()内写链接地址。如下:

[文字描述](链接地址)

[百度](https://baidu.com/)

结果如下:

百度

引用式链接(建议使用,防止大量链接嵌入正文修改时不方便)

> 格式
[文字描述][引用式链接标识] 或者 [引用式链接标识][]

> 文章末尾加
[引用式链接标识]: 链接地址

例如:

> 文章中使用
[百度][Baidu] 或 [Baidu][]

> 文章末尾加
[Baidu]: https://baidu.com/

结果如下:

百度 Baidu

2.8 图片

链接的格式是在符号 []内写写文字,后跟着 ()内写链接地址。如下:

![图片描述](链接地址) 或 ![图片描述](相对文件地址)

链接地址:正常URL链接

相对文件地址:
  同级目录 -> assets/img.png
  上级级目录 -> ../public/assets/img.png

图片也可以使用引用式链接

例如:

![图片描述](https://i2.hdslb.com/bfs/archive/8bbf4d959c58fd7511be7523b126c7f5374d28cb.jpg)

图片描述

设置图片大小

<img src="https://i2.hdslb.com/bfs/archive/8bbf4d959c58fd7511be7523b126c7f5374d28cb.jpg" width="50%" height="50%"/>
<img src="https://i2.hdslb.com/bfs/archive/8bbf4d959c58fd7511be7523b126c7f5374d28cb.jpg" width="300px" height="100px"/>

2.9 分割线

可以在一行中用三个以上的减号来建立一个分隔线,同时需要在分隔线的上面空一行。如下:


---

结果如下:


2.10 表格

可以使用竖线 |加空格分隔表格列,换行使用冒号 :加横线 -来定义表格的对齐方式,单元格内空格多少不影响显示效果,保证至少一个即可,如下:

| 名称 | 数量(居中) | 描述(右对齐) |
| :-- | :--: | --: |
| 可爱多 |  1  |    可爱多 |
| 可爱多可爱多 |  2 |   可爱多可爱多 |
| 可爱多可爱多可爱多 |  3  | 可爱多可爱多 |

结果如下:

名称数量(居中)描述(右对齐)
可爱多1可爱多
可爱多可爱多2可爱多可爱多
可爱多可爱多可爱多3可爱多可爱多

2.11 代码块

如果在一个行内需要引用代码,只要用反引号引起来就好,如下:

`你好,世界。`
`Hello, World.`

结果:你好,世界。 Hello, World.

如需要引用一段代码,在高亮的代码块的前一行及后一行使用三个反引号,可以标注代码语言(java/go/xml/json...),如下:

java
public class HelloWorld {
  public static void main(String[] args) {
    System.out.println("Hello,World!");
  }
}