Markdown使用教程推荐

简介

《河西走廊》是一部由中共甘肃省委宣传部、中央电视台科教频道联合出品，北京伯璟文化传播有限公司承制的十集系列纪录片。该片以位于中国西部的重要通道，丝绸之路的黄金段——河西走廊为讲述对象，从政治、军事、经济、文化、宗教等多角度呈现了从汉代开始直至今天，河西走廊及其连接的中国西部的历史，以及它对中国历史和文明进程中所发挥的独特作用。“河西走廊关乎国家经略”是贯穿全篇的主题。

Markdown使用教程

十、图片

官方大流量卡推荐, 不限速，超低价，快递包邮

和链接的区别是前面多一个感叹号!

markdown

![图片名](图片链接)

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

markdown

这里链接用 img 作为图片地址变量
然后在文档的结尾或其他位置给变量赋值（图片地址）
![RUNOOB][img]
[img]: https://raw.githubusercontent.com/xugaoyi/image_store/master/blog/md_logo.png

RUNOOB

图片宽高

如下想设置图片宽高，可以使用 <img> 标签。

html

<img src="https://raw.githubusercontent.com/xugaoyi/image_store/master/blog/md_logo.png" width="50px" height="30px">

TODO 待办列表

输出：

吃饭
睡觉
打豆豆

输入：

markdown

- [ ] 吃饭
- [ ] 睡觉
- [x] 打豆豆

确保 [ ] 里有一个空格。

提示

支持所有列表语法，如：1.、-、+、* 等。

内容居中容器

输出：

Markdown 拓展

（这是二级标题）

输入：

markdown

::: center
Markdown 拓展
:::

::: center

## Markdown 拓展

（这是二级标题）
:::

内容居右容器

居右的内容字体为 14px。

输出：

测试 right

摘要

很久之前，我决定踏上的这条路，映照了我与未来的因果。

2021-11-13

输入：

markdown

::: right
测试 right
:::

::: tip 摘要
很久之前，我决定踏上的这条路，映照了我与未来的因果。
::: right
2021-11-13
:::

笔记容器

笔记容器和 Vitepress 的 Github NOTE 容器样式一样，Teek 将其转为 :::note 启用。

输出：

NOTE

这是一个笔记 Note 容器。

输入：

markdown

:::note
这是一个笔记 Note 容器。
:::

Video 容器

Video 容器可以快速嵌入不同平台的视频：

bilibili：Bilibili 视频
tencent：腾讯视频
youku：优酷视频
youtube：YouTube 视频
vimeo：Vimeo 视频
xigua：西瓜视频
自定义视频链接

以 bilibili 为例，输出：

自定义视频链接，输出：

五、文本

段落

Markdown 段落没有特殊的格式，直接编写文字，需要段落缩进时使用2个Tab

字体

markdown

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

斜体文本

粗体文本

粗斜体文本

删除线

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

markdown

~~BAIDU.COM~~

~~BAIDU.COM~~

下划线

下划线可以通过 HTML 的 标签来实现：

markdown

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

带下划线的文本

文字高亮

文字高亮能使行内部分文字高亮，使用一对反引号。

markdown

`html` `css` `javascript`

html css javascript

分隔线

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

markdown

***

*****

- - -

----------

脚注

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

markdown

[^变量]
在文档结尾或其他位置給变量赋值：
[^变量]: 注明框内显示的内容

鼠标移到这里> [^哈喽]
[^哈喽]: 注明框内显示的内容

注：在部分线上预览未支持

鼠标移到这里> ^哈喽

六、列表

无序列表

使用星号*、加号+或是减号-作为列表标记：

markdown

* 第一项
* 第二项

+ 第一项
+ 第二项

- 第一项
- 第二项

第一项
第二项

第一项
第二项

带复选框列表

markdown

* [x] 第一项
* [ ] 第二项
* [ ] 第三项

注：在部分线上预览未支持

第一项
第二项
第三项

列表嵌套

markdown

1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
       - 第三层嵌套

第一项
- 嵌套1
- 嵌套2
第二项
- 嵌套1
  - 嵌套2

七、区块引用

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

markdown

> 区块引用

区块引用
Typora中回车键自动延伸区块

区块嵌套

markdown

> 第一层
> > 第二层
> > > 第三层

第一层
第二层
第三层

区块中使用列表

markdown

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> * 111
> * 222

区块中使用列表
第一项
第二项
111
222

列表中使用区块

markdown

* 第一项
    > 区块
* 第二项

第一项
区块
区块
第二项

八、代码

如果是段落上的一个代码片段可以用反引号把它包起来（`），示例：

markdown

`alert()`

alert()

九、链接

格式：

markdown

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

[链接名称](链接地址,可选的alt)

或

<链接地址>

示例：

markdown

[百度](http://www.baidu.com,'百度')

百度

直接显示链接地址：

markdown

<http://www.baidu.com>

http://www.baidu.com

变量链接

链接可以用变量来代替，文档末尾或其他位置附带变量地址：

markdown

这个链接用 1 作为网址变量 [Google][1]
这个链接用 baidu 作为网址变量 [Baidu][baidu]

然后在文档的结尾或其他位置给变量赋值（网址）
  [1]: http://www.google.com/
  [baidu]: http://www.baidu.com/

这个链接用 1 作为网址变量 Google

这个链接用 baidu 作为网址变量 Baidu

Github仓库中使用内部链接

markdown

可使用相对路径（前提是有该路径下的文件）
[test](test.md)

test

十一、表格

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

markdown

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

表头	表头
单元格	单元格
单元格	单元格

对齐方式

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

markdown

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

左对齐	右对齐	居中对齐
单元格	单元格	单元格
单元格	单元格	单元格

十二、Emoji表情包

Emoji表情英文名的前后加冒号，Typore上先输入冒号再输入首字母有表情提示

markdown

:smirk:

💋 😸🙈🐴 😏😊😃😄 ☀️

更多表情名称请查看：表情包清单

十三、其他技巧

支持的 HTML 元素

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

目前支持的 HTML 元素有：<kbd> 等等，如：

markdown

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

使用 Ctrl+Alt+Del 重启电脑

我是使用b标签的加粗字体

转义

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

markdown

**未转义星号显示加粗**
\*\* 转义显示星号 \*\*

未转义星号显示加粗 ** 转义显示星号 **

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

markdown

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

图表

markdown

```chart
,Budget,Income,Expenses,Debt
June,5000,8000,4000,6000
July,3000,1000,4000,3000
Aug,5000,7000,6000,3000
Sep,7000,2000,3000,1000
Oct,6000,5000,4000,2000
Nov,4000,3000,5000,

type: pie
title: Monthly Revenue
x.title: Amount
y.title: Month
y.suffix: $
```
```mermaid
sequenceDiagram
A->>B: 是否已收到消息？
B-->>A: 已收到消息
```

注：在Typora中未支持

流程图

markdown

语法：
```mermaid
graph TD
A[模块A] -->|A1| B(模块B)
B --> C{判断条件C}
C -->|条件C1| D[模块D]
C -->|条件C2| E[模块E]
C -->|条件C3| F[模块F]
```

流程图相关文章：

https://www.jianshu.com/p/b421cc723da5

http://www.imooc.com/article/292708

时序图

markdown

```mermaid
sequenceDiagram
A->>B: 是否已收到消息？
B-->>A: 已收到消息
```

甘特图

markdown

```mermaid
gantt
title 甘特图
dateFormat  YYYY-MM-DD
section 项目A
任务1           :a1, 2018-06-06, 30d
任务2     :after a1  , 20d
section 项目B
任务3      :2018-06-12  , 12d
任务4      : 24d
```

五、文本

段落

Markdown 段落没有特殊的格式，直接编写文字，需要段落缩进时使用2个Tab

字体

markdown

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

斜体文本

粗体文本

粗斜体文本

删除线

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

markdown

~~BAIDU.COM~~

~~BAIDU.COM~~

下划线

下划线可以通过 HTML 的 标签来实现：

markdown

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

带下划线的文本

文字高亮

文字高亮能使行内部分文字高亮，使用一对反引号。

markdown

`html` `css` `javascript`

html css javascript

分隔线

markdown

***

*****

- - -

----------

脚注

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

markdown

[^变量]
在文档结尾或其他位置給变量赋值：
[^变量]: 注明框内显示的内容

鼠标移到这里> [^哈喽]
[^哈喽]: 注明框内显示的内容

注：在部分线上预览未支持

鼠标移到这里> ^哈喽

六、列表

无序列表

使用星号*、加号+或是减号-作为列表标记：

markdown

* 第一项
* 第二项

+ 第一项
+ 第二项

- 第一项
- 第二项

第一项
第二项

有序列表

使用数字并加上 . 号来表示

markdown

1. 第一项
2. 第二项

第一项
第二项

带复选框列表

markdown

* [x] 第一项
* [ ] 第二项
* [ ] 第三项

注：在部分线上预览未支持

第一项
第二项
第三项

列表嵌套

markdown

1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
       - 第三层嵌套

第一项
- 嵌套1
- 嵌套2
第二项
- 嵌套1
  - 嵌套2

七、区块引用

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

markdown

> 区块引用

区块引用
Typora中回车键自动延伸区块

区块嵌套

markdown

> 第一层
> > 第二层
> > > 第三层

第一层
第二层
第三层

区块中使用列表

markdown

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> * 111
> * 222

区块中使用列表
第一项
第二项
111
222

八、代码

如果是段落上的一个代码片段可以用反引号把它包起来（`），示例：

markdown

`alert()`

alert()

代码区块

用三个反引号 ``` 包裹一段代码，并指定一种语言（也可以不指定），指定代码语言后会有代码的颜色高亮

本代码区块为示例说明：

markdown

```javascript
function test() {
	alert('test')
}
```

效果：

javascript

function test() {
	alert('test')
}

九、链接

格式：

markdown

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

[链接名称](链接地址,可选的alt)

或

<链接地址>

示例：

markdown

[百度](http://www.baidu.com,'百度')

百度

直接显示链接地址：

markdown

<http://www.baidu.com>

http://www.baidu.com

变量链接

链接可以用变量来代替，文档末尾或其他位置附带变量地址：

markdown

这个链接用 1 作为网址变量 [Google][1]
这个链接用 baidu 作为网址变量 [Baidu][baidu]

然后在文档的结尾或其他位置给变量赋值（网址）
  [1]: http://www.google.com/
  [baidu]: http://www.baidu.com/

这个链接用 1 作为网址变量 Google

这个链接用 baidu 作为网址变量 Baidu

十、图片

和链接的区别是前面多一个感叹号!

markdown

![图片名](图片链接)

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

markdown

这里链接用 img 作为图片地址变量
然后在文档的结尾或其他位置给变量赋值（图片地址）
![RUNOOB][img]
[img]: https://raw.githubusercontent.com/xugaoyi/image_store/master/blog/md_logo.png

RUNOOB

图片宽高

如下想设置图片宽高，可以使用 <img> 标签。

html

<img src="https://raw.githubusercontent.com/xugaoyi/image_store/master/blog/md_logo.png" width="50px" height="30px">

相对路径以及Github中使用图片

不管是在本地还是在github同一个仓库中，如果图片存在，可以使用相对路径。

相对路径图片：

markdown

![头像图片](./md-img/test.jpg)

github上如果引用其他github仓库中的图片则要注意地址格式：仓库地址/raw/分支名/图片路径 或 https://raw.githubusercontent.com/用户名/仓库名/分支名/图片路径

markdown

![其他仓库的图片1](https://github.com/xugaoyi/vue-music/raw/master/src/common/image/default.png)
或
![其他仓库的图片2](https://raw.githubusercontent.com/xugaoyi/image_store/master/blog/md_logo.png)

其他仓库的图片

其他仓库的图片2

十一、表格

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

markdown

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

表头	表头
单元格	单元格
单元格	单元格

对齐方式

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

markdown

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

左对齐	右对齐	居中对齐
单元格	单元格	单元格
单元格	单元格	单元格

十二、Emoji表情包

Emoji表情英文名的前后加冒号，Typore上先输入冒号再输入首字母有表情提示

markdown

:smirk:

💋 😸🙈🐴 😏😊😃😄 ☀️

更多表情名称请查看：表情包清单

十三、其他技巧

支持的 HTML 元素

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

目前支持的 HTML 元素有：<kbd> 等等，如：

markdown

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

使用 Ctrl+Alt+Del 重启电脑

我是使用b标签的加粗字体

转义

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

markdown

**未转义星号显示加粗**
\*\* 转义显示星号 \*\*

未转义星号显示加粗 ** 转义显示星号 **

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

markdown

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

*** 以下部分在Github或其他在线预览中暂未支持 ***

Markdown | 入门教程

现代汉语就像用脏了的人民币，要用 Markdown 洗一洗。Markdown 是一种轻量级标记语言。你不需要关心标题多大字号、段前距多少、列表缩进几格，只要在纯文本前后增加一些标记符号（例如 # - * >），就能毫不费力地写出工整精美的文章。

优势

易学易记

只要几分钟就可以学会 Markdown，然后你可能再也不想碰 Word 了。

专注写作

富文本编辑器（例如 Word）是通过点击图形化的功能按钮来实现排版，而 Markdown 则是通过标记字符去赋予文字不同格式。

易读易写，让任何与文字打交道的人专注于写作，不用操心排版。

格式统一

同一份 Word 文档，在

不同的设备：Windows、macOS、Android、iOS
不同的版本：旧版 Word、新版 Word
不同的软件：Microsoft Office、WPS

可能显示不一样的效果。

而 Markdown 可以一次编写，到处运行。

不管在电脑上，还是手机上，用 Markdown 写出来的文章都能带来舒适、统一、美好的阅读体验。

向外兼容

可以导出 PDF、Word、HTML、图片等格式分享给没有安装 Markdown 编辑器的人。

入门

一开始你只要记住以下符号（英文半角状态），就能写出排版清爽的文章了。

语法	标记结果
`#` + `空格` + `文本`	一级标题
`##` + `空格` + `文本`	二级标题
`###` + `空格` + `文本`	三级标题
`-` + `空格` + `文本`	无序列表
`1` + `.` + `空格` + `文本`	有序列表
`>` + `空格` + `文本`	引用

如果有些文字需要特殊说明：

语法	标记结果
`` + `加粗` + ``	加粗
`` + `斜体` + ``	斜体
`~~` + `删除线` + `~~`	~~删除线~~

其他：

语法	名称
`---`、`***`、`+++`	分割线
`[TOC]`	内容目录

进阶

以上就是最基础的 Markdown 语法，普通用户看到这里就可以开始动笔尝试了。下面介绍一些 Markdown 的书写风格，让你的源码和文档更精美，更有条理。你不必一下子全部记住，需要实现哪个功能再来查阅或者问 Google 也不迟。

标题

层级

正文的标题从 ## 开始，# 要留给整篇文章的标题（也可以不写）。这样的大纲结构也可以很方便地转换为思维导图，也符合 SEO（搜索引擎优化）的规则。
markdown
```
# 一级标题（h1）：文章的标题

## 二级标题（h2）：正文的大标题

### 三级标题（h3）：正文的小标题
```
1
2
3
4
5

虽然 Markdown 最大支持 ###### 六级标题，为了保持层级的简单，防止出现过于复杂的章节，请谨慎使用四级标题（除非是长文章）。如果三级标题下有并列性的内容，可以使用加粗、有序列表或无序列表代表末级标题。

markdown

短文章的标题层级

### 正文的小标题

**三级标题 A**
- 论据 1（五级标题）
  - 细分论据 1（六级标题）
  - 细分论据 2（六级标题）
  - 细分论据 3（六级标题）
- 论据 2
- 论据 3

**三级标题 B**
1. 论据
2. 论据
3. 论据

**三级标题 C**
- 论据 1
- 论据 2
- 论据 3

markdown

长文章的标题层级

### 正文的小标题

#### 正文的三级标题 A

#### 正文的三级标题 B

#### 正文的三级标题 C

二级标题下，不能直接出现四级标题。
标题要避免孤立编号（即同级标题只有一个）。
标题要简短，结尾不带标点符号。
源码中，标题前后空一行（段前距和段后距）。

大标题和小标题之间要有内容过渡（引出或概括下文）。

markdown

# Title

开门见山地告诉读者这篇文章讲什么？
一级标题作为文章的（页面）标题（H1），并且尽可能和文件名称保持一致。
如果文章很长，使用 [TOC] 生成目录。

## What

先定义问题是什么？……
正文从二级标题开始。

## Why

为什么会出现这样的问题？……

## How

下一步该怎么办？……

## See also

文末别忘了贴上参考链接。

列表

无序列表

使用 ‐ 或 * 或 + 并跟随 1 个空格来表示无序列表。建议使用 ‐。

markdown

- 我是谁
- 我从哪里来
- 我到哪里去

不建议

markdown

* 我是谁
* 我从哪里来
* 我到哪里去

---

+ 我是谁
+ 我从哪里来
+ 我到哪里去

为什么

星号 * 可能和加粗和斜体符号产生混淆。
加号 + 不流行。

与其他语法结合使用

markdown

- **《春日》**：等闲识得东风面，万紫千红总是春。
- **《春草》**：萋萋总是无情物，吹绿东风又一年。
- **《墨梅》**：犹恨东风无意思，更吹烟雨暗黄昏。

预览

《春日》：等闲识得东风面，万紫千红总是春。
《春草》：萋萋总是无情物，吹绿东风又一年。
《墨梅》：犹恨东风无意思，更吹烟雨暗黄昏。

有序列表

语法一（手动排序）

markdown

1. 斜月沉沉藏海雾，碣石潇湘无限路。
2. 不知乘月几人归，落月摇情满江树。
3. 春江潮水连海平，海上明月共潮生。

预览

斜月沉沉藏海雾，碣石潇湘无限路。
不知乘月几人归，落月摇情满江树。
春江潮水连海平，海上明月共潮生。

对于比较短的、很少修改的有序列表，请按顺序标号，保持源码的可读性。

语法二（自动排序）

对于比较长的、可能会修改的列表（尤其是很长的嵌套列表），请使用「懒人编号法」。纵使有新的列表项「插队」，把序号弄乱了也没关系，Markdown 编辑器自动会对序号进行纠错。

markdown

1. Foo.
1. Bar.
    1. Foofoo.
    1. Barbar.
    1. Gargar
1. Baz.

预览

Foo.
Bar.
1. Foofoo.
2. Barbar.
3. Gargar
Baz.

嵌套列表

缩进 2 ~ 4 个空格或一个 Tab（推荐），可以嵌套列表。

示例一

markdown

1. 不知乘月几人归，落月摇情满江树。
    - 与君吟弄风月，端不负平生。
    - 对秋深，离恨苦，数夜满庭风雨。
    - 五月畲田收火米，三更津吏报潮鸡。
2. 人姝丽，粉香吹下，夜寒风细。
    - 弓弦抱汉月，马足践胡尘。
    - 寒月悲笳，万里西风瀚海沙。
    - 东堂坐见山，云风相吹嘘。
3. 沅溪夏晚足凉风，春酒相携就竹丛。
    - 白发渔樵江渚上，惯看秋月春风。
    - 归来独卧逍遥夜，梦里相逢酩酊天。
    - 致君尧舜上，再使风俗淳。

预览

不知乘月几人归，落月摇情满江树。
- 与君吟弄风月，端不负平生。
- 对秋深，离恨苦，数夜满庭风雨。
- 五月畲田收火米，三更津吏报潮鸡。
人姝丽，粉香吹下，夜寒风细。
- 弓弦抱汉月，马足践胡尘。
- 寒月悲笳，万里西风瀚海沙。
- 东堂坐见山，云风相吹嘘。
沅溪夏晚足凉风，春酒相携就竹丛。
- 白发渔樵江渚上，惯看秋月春风。
- 归来独卧逍遥夜，梦里相逢酩酊天。
- 致君尧舜上，再使风俗淳。

示例二

markdown

- 栏目
    > - 排版美学
    > - 数字生活
    > - 日志随笔

- 联系方式
    > - Email：***@gmail.com
    > - Telegram：t.me/***
    > - WeChat：***

预览

栏目
- 排版美学
- 数字生活
- 日志随笔
联系方式
- Email：***@gmail.com
- Telegram：t.me/***
- WeChat：***

Tips

Tab 缩进一级
Shift + Tab 提升一级

任务列表

语法

markdown

- [ ] 纯牛奶
- [x] 西瓜
- [ ] 鸡蛋
- [x] 保鲜膜
- [ ] 猪肉

预览

纯牛奶
西瓜
鸡蛋
保鲜膜
猪肉

引用

在每一行使用 > 符号，包括换行的句子。

markdown

> 我们是为人民服务的，所以，我们如果有缺点，就不怕别人批评指出。
>
> by 毛泽东：《为人民服务》（1944 年 9 月 8 日）

我们是为人民服务的，所以，我们如果有缺点，就不怕别人批评指出。
by 毛泽东：《为人民服务》（1944 年 9 月 8 日）

表格

语法

markdown

| 左对齐           |                      居中对齐                      | 右对齐 |
| :--------------- | :------------------------------------------------: | -----: |
| **加粗**         |           [插入链接](https://lisir.me/)            |   ￥5.7 |
| 换行 <br> 下一行 | ![插入图片](https://chat.deepseek.com/favicon.svg) |  ￥10.4 |

预览

左对齐	居中对齐	右对齐
加粗	插入链接	￥5.7
换行下一行		￥10.4

注释

Markdown 是轻量级的标记语言，所以不支持合并和拆分单元格。
对于复杂表格，你可以在 Markdown 编辑器中使用 HTML 的 <table> 标签标记。
输入   可以换行（但不建议使用）。
把 Excel 表格复制粘贴到某些 Markdown 编辑器可以直接转换为 Markdown 形式的表格。

链接

语法

markdown

[LI SIR - 个人博客](https://lisir.me/)

预览：LI SIR - 个人博客

图片

语法

markdown

![插入图片](https://chat.deepseek.com/favicon.svg)

预览

Markdown 是一种纯文本标记语言，图片功能注定是它的弱项。

代码

行内代码

用 2 个重音符 `（backtick，在 Tab 键上方）包裹

markdown

`Markdown` 是一种轻量级标记语言。

预览

Markdown 是一种轻量级标记语言。

用两个 ` 包裹，才能显示 `：

markdown

A single backtick in a code span: `` ` ``

A backtick-delimited string in a code span: `` `foo` ``

预览

A single backtick in a code span: `

A backtick-delimited string in a code span: `foo`

重音符前后空一格

markdown

- 推荐：使用键盘快捷键 `Ctrl + D` 可以将当前网页保存为书签。
- 反对：使用键盘快捷键`Ctrl + D`可以将当前网页保存为书签。

预览

推荐：使用键盘快捷键 Ctrl + D 可以将当前网页保存为书签。
反对：使用键盘快捷键Ctrl + D可以将当前网页保存为书签。

代码块

将 3 个重音符 ` 置于代码块的首行和末行。首行的重音符后面可接代码语言名称，例如 ```python，以达到相应的代码高亮效果。

markdown

```python
print "Hello, Python!"
```

预览

python

print "Hello, Python!"

diff 代码对比

markdown

```diff
function addTwoNumbers (num1, num2) {
-  return 1 + 2
+  return num1 + num2
}
```

预览

diff

function addTwoNumbers (num1, num2) {
-  return 1 + 2
+  return num1 + num2
}

换行

在行末使用 空格（两个以上），就可以实现强制换行，此语法适用于大部分 Markdown 编辑器。

硬换行在文档被导出时将被保留，且没有换段的段后距。

markdown

`enticing` [ɪn'taɪsɪŋ] （事物）诱人的，有吸引力的；迷人的

- Her neck was short but rounded and her arms plump and enticing. `两个空格`
  她的脖子短，但浑圆可爱；两臂丰腴，也很动人。by《飘》

- This was enticing to Wozniak, even more than any prospect of getting rich. `两个空格`
  这句话对沃兹尼亚克的诱惑太大了，比变成富人的诱惑还要大。by《乔布斯传》

enticing [ɪn'taɪsɪŋ] （事物）诱人的，有吸引力的；迷人的

Her neck was short but rounded and her arms plump and enticing.
她的脖子短，但浑圆可爱；两臂丰腴，也很动人。by《飘》
This was enticing to Wozniak, even more than any prospect of getting rich.
这句话对沃兹尼亚克的诱惑太大了，比变成富人的诱惑还要大。by《乔布斯传》

markdown

假如生活欺骗了你， `两个空格`
不要悲伤，不要心急！ `两个空格`
忧郁的日子里须要镇静： `两个空格`
相信吧，快乐的日子将会来临！ `两个空格`
心儿永远向往着未来； `两个空格`
现在却常是忧郁。 `两个空格`
一切都是瞬息，一切都将会过去； `两个空格`
而那过去了的，就会成为亲切的怀恋。 `两个空格`
by 普希金

假如生活欺骗了你，
不要悲伤，不要心急！
忧郁的日子里须要镇静：
相信吧，快乐的日子将会来临！
心儿永远向往着未来；
现在却常是忧郁。
一切都是瞬息，一切都将会过去；
而那过去了的，就会成为亲切的怀恋。
by 普希金

文案风格及排版指南

评价一个科技媒体或者设计师是否专业，我会看中英文之间是否空一格，因为美好的文字值得用更优雅更干净的方式呈现。

拼写正确

尊重专有名词的正确写法，是写作 / 排版的第一步：

✔️	❌
App、app	APP
App Store	Appstore
a.m.	am、AM、A.M.（上午）
email	E-mail、Email
GitHub	Github、github
Google	google
iOS	IOS
iPhone XS Max	Iphone xs MAX
macOS	MacOS
kg	KG、Kg
km	Km、KM
Markdown	MarkDown
OK	ok
P.S.	PS、ps、Ps.
Siri	siri
WeChat	Wechat、wechat
WhatsApp	Whatsapp、whatsapp
Wi-Fi	WIFI、WiFi、wifi
YouTube	Youtube
4K	4k
1080p	1080P
登录	登陆
账号	帐号、账户、帐户

英文拼写错误

❗ ️大写有突出强调的作用，意味着这个单词或者句子很重要。

句首字母大写
- ❌ how are you?
- ✔️ How are you?
专有名词大写
- ❌ Happy mid-autumn festival
- ✔️ Happy Mid-Autumn Festival（连字符用最短的 hyphen）
I 在任何时候都大写
- ❌ I am a slow walker, but i never walk back.
- ✔️ I am a slow walker, but I never walk back.
- 📝 我走得很慢，但是我从来不会后退。by 亚伯拉罕·林肯（Abraham Lincoln）
internet 首字母不再大写
- 一开始的 Internet 首字母是大写（特殊的专有名词），随着互联网的普及，它不再特殊，所以被降级成 internet。
App
- App 念作 [æp] ，而非 A-P-P（爱啪啪）。
- 当用于标题或首字母时，写作「App」，当用于正文泛指时写作「app」。
- App 的复数形式是「apps」。

符号拼写错误

罗马数字
- ✔️ I、Ⅱ、Ⅲ（它们是一个整体）
- ❌ I、II、III（用一个或多个大写字母 I 代替）
乘号
- ✔️ ×（微软拼音输入 cheng 即可弹出正宗的乘号）
- ❌ 字母 x 或 X 代替

借助搜索引擎、官方网站和维基百科，你不难找到专有名词应该怎么写。

来自 Anyway.FM 的 UI 行业英文术语聚合：Anyway.ABC 安妮薇术语小词典

增加空格

行文时，请务必在全角字符（汉字）和半角字符（字母、数字或符号）之间空一格（半角空格）。混排时，通过刻意增加空格的方式，会让段落看起来不那么「拥挤」，增加中英混排的美感。

中文与英文之间增加空格
- ✔️ 通过 Google 搜索引擎，你可以更快地找到想要的信息。
- ❌ 通过Google搜索引擎，你可以更快地找到想要的信息。
- 📝「豆瓣FM」等专有产品名词，按照官方所定义的格式书写。
中文与数字之间增加空格
- ✔️ 2021 年 12 月 20 日，我的博客「LISIR」发出第 1 篇文章。
- ❌ 2021年12月20日，我的博客「LISIR」发出第1篇文章。
中文与链接之间增加空格
- ✔️ 我的博客于 2021 年 12 月 20 日正式运营。
- ❌ 我的博客于 2021 年 12 月 20 日正式运营。
数字与单位之间增加空格
- ✔️ iPhone XS 显示屏的像素密度是 458 ppi，最大亮度（标准）是 625 cd/m²。
- ❌ iPhone XS 显示屏的像素密度是 458ppi，最大亮度（标准）是 625cd/m²。
- 📝 我的手机可用储存空间只剩 1GB 了。（在 Apple 的排版哲学中，这是个特例。是否要空一格，看你的个人选择。）

标点符号

中文标点符号必须使用全角字符。排版时，它们占用的宽度等于一个中文字符；

而英文一般使用半角标点符号。排版时，它们占用的宽度等于半个中文字符。

✔️ 三毛说：「心若没有栖息的地方，到哪里都是在流浪。」
❌ 三毛说:「心若没有栖息的地方,到哪里都是在流浪. 」
✔️ 请确认所有的连接（电缆和接插件）均安装牢固。
❌ 请确认所有的连接(电缆和接插件)均安装牢固。
📝 请确认所有的连接 (电缆和接插件) 均安装牢固 (Apple 的做法：半角括号 + 前后空格)。

完整的英文句子，用半角标点符号

✔️ 乔布斯说过：「Stay hungry, stay foolish.」
❌ 乔布斯说过：「Stay hungry，stay foolish。」

中文符号

感叹号 ！
不到万不得已，坚决不用感叹号。平和地表达，才能发出理性的声音。
- ✔️ 心平气和地表达自己的看法，尽量避免使用感叹号！
- ❌ 心平气和地表达自己的看法，尽量避免使用感叹号！！！（不要重复使用标点符号）
- 📝 当句子包含疑问、感叹两种语气都比较强烈时（如带有强烈感情的反问句和带有惊愕语气的疑问句），可在问号后再加叹号，例如「这点困难就能把我们吓倒吗？！」
省略号 ……
如何输入：
- ✔️ 切换到中文输入法， Shift + 6（在主键盘的字母 T 上方）即可输入正确的省略号 ……
- ❌ 多个中文句号代替 。。。 或多个英文句点代替 ......
省略号不应与「等」这个词一起使用：
- ❌ 我们为会餐准备了香蕉、苹果、梨…等各色水果。
- ✔️ 我们为会餐准备了各色水果，有香蕉、苹果、梨……
- ✔️ 我们为会餐准备了香蕉、苹果、梨等各色水果。
逗号 ，
- 逗号表示句子内部的一般性停顿。
- 注意避免「一逗到底」，即整个段落除了结尾，全部停顿都使用逗号。
顿号 、
并列形容词之间用顿号：
- ✔️ 这里有自由、民主、平等、开放的风气和氛围。
- ❌ 这里有自由，民主，平等，开放的风气和氛围。
最后一项内容前已经用了「及」、「以及」、「和」等字样，则最后一项前不再使用顿号：
- ✔️ 警方还组织数千民兵专门看护桥梁、过街天桥、涵洞和道口等重点部位。
- ❌ 警方还组织数千民兵专门看护桥梁、过街天桥、涵洞、和道口等重点部位。
不能用 ， 代替顿号 、：
- ✔️ 警方还组织数千民兵专门看护桥梁、过街天桥、涵洞等重点部位。
- ❌ 警方还组织数千民兵专门看护桥梁，过街天桥，涵洞等重点部位。
如果并列的是短句，应使用逗号：
- ✔️ 我问了他很多问题，三年前在干什么，两年前在干什么，今后打算干什么……
- ❌ 我问了他很多问题、三年前在干什么、两年前在干什么、今后打算干什么……
标有引号的并列成分之间、标有书名号的并列成分之间通常不用顿号。若有其他成分插在并列的引号之间或并列的书名号之间（如引语或书名号之后还有括注），宜用顿号：
- ✔️ ️️「日」「月」构成「明」字。
- ✔️ 店里挂着「顾客就是上帝」「质量就是生命」等横幅。
- ✔️《红楼梦》《三国演义》《西游记》《水浒传》是我国长篇小说的四大名著
- ✔️ 李白的「白发三千长」（《秋浦歌》）、「朝如青丝暮成雪」（《将进酒》）都是脍炙人口的诗句。
括号 （）
中文夹用英文注释，用中文全角圆括号标示注释：
- ✔️ The Beatles（1968）有一首歌，题为《除了我和我的猴子人人都想捂藏一点东西》（Everybody's Got Something to Hide except Me and My Monkey），这首歌后来音乐家称之为《猴子》。
- ❌ The Beatles(1968) 有一首歌，题为《除了我和我的猴子人人都想捂藏一点东西》(Everybody's Got Something to Hide except Me and My Monkey)，这首歌后来音乐家称之为《猴子》。
句子末尾用括号加注时，句号应在括号之外：
- ✔️ 关于文件的输出，请参照第 1.3 节（见第 26 页）。
- ❌ 关于文件的输出，请参照第 1.3 节（见第 26 页。）
波浪号 ～
梨园乡种植的巨风葡萄今年已经进入了丰产期，亩产 1000 公斤 ~ 1500 公斤。
这句话使用了错误的（半角）波浪号 ~ 作为（全角）浪纹号 ～ 来标示数值范围的起止。
如何输入正确的浪纹号？以微软拼音为例：
1. 切换到全角状态（Shift + Space）
2. Shift + ~（Esc 的下方）
3. 切换回半角状态，接着输入其他内容
因此，输入正确的浪纹号是一件很麻烦的事，推荐使用 至 或者 到 代替 ～ ：亩产 1000 公斤至 1500 公斤。

英文符号

使用英文（半角）标点符号
- ❌ I’m Tim。（使用中文全角标点符号）
- ✔️ I'm Tim.
标点符号后面空一格
- ❌ Mr.Zhong
- ✔️ Mr. Zhong
- ❌ We need seven people:three students,three engineers,and a professor.
- ✔️ We need seven people: three students, three engineers, and a professor. （注意 and 前面有一个逗号）
每句话与上一句的标点之间一定要有空格。空格是分隔单词用的，如果前后两句话之间没有空格，那么上一句的最后一个词，和下一句的第一个词，就连在一起了。比如 I_am_here._It_is_8:00_now. 如果写成 I am here.It is 8:00 now. 那么 here.it 这样是不规范的，只有同一个词中才会出现这样的写法，比如 a.m. 、U.S.A. 中间没有空格，看做是一个词。上边的 here.it 甚至可能被一些网站当成是链接网址，因为 .it 是一个域名，网址中间是不加空格的。
成对符号（括号和引号）前后空一格
- ❌ The screen is 6.46 inches(iPhone XS Max)diagonally.
- ✔️ The screen is 6.46 inches (iPhone XS Max) diagonally.
- ❌ He said,"I may forget your name,but I never forget a face."
- ✔️ He said, "I may forget your name, but I never forget a face."
在某些 Style Guide 中，纵使在中文语境下，也会将（中文）全角括号替换为 (英文) 半角括号，并在括号外添加半角空格（两个连续的标点之间不添加空格）： iPhone SE 可防溅、抗水、防尘，在受控实验室条件下经测试，其效果在 IEC 60529 标准下达到 IP67 级别 (在最深 1 米的水下停留时间最长可达 30 分钟)。by Apple
省略号
- ❌ Juan thought and thought…and then thought some more.（省略号前后没有空格）
- ❌ Juan thought and thought ... and then thought some more.（三个英文句号代替省略号）
- ✔️ Juan thought and thought … and then thought some more. （省略号是一个整体，不可分割）
表示中文时，英文省略号（⋯）应改为中文省略号（……）
- 英文：5 minutes later⋯
- 中文：5 分钟过去了⋯⋯
小数点
不严谨地说，东方世界是万位计数法（1 2345 6789.10），而西方世界则是千位计数法（123 456 789.10）。不管是哪一种计数法，在数额巨大时，插入定界符（delimiter）可以方便读者辨识这串数字到底有多大。而在西文中，由于小数点符号（decimal separator 或 decimal mark）的使用习俗不同，会间接影响到千分位符号（也称千位分隔符，group separator）的选择，所以这些写法在不同国家会代表不同数值：12,345、12.345、12,345.678 与 12.345,678。
小数点用来分隔数字的整数部分与小数部分。如 3.14 中的 .，但地球是圆的：
- 汉语地区和大多的英语地区：使用 . 句点（full stop）作为小数点
- 大多的其他欧洲国家和其前殖民地：使用 , 逗号（comma）作为小数点
长串数字千分位小数点常用于
125,124,024.25 , . 英美
125.124.024,25 . , 欧洲
125 124 024,25 , 国际单位制（逗号地区）
125 124 024.25 . 国际单位制（句点地区）
表并列
中文：不要用逗号代替顿号
- ❌ 警方还组织数千民兵专门看护桥梁，过街天桥，涵洞等重点部位。
- ✔️ 警方还组织数千民兵专门看护桥梁、过街天桥、涵洞等重点部位。
英文：用逗号表示并列关系（不存在顿号）
- ❌ We need seven people: three students、three engineers、and a professor.
- ✔️ We need seven people: three students, three engineers, and a professor.
不存在的标点符号
顿号：没有 、 顿号，用逗号 , 表并列：
- She slowly, carefully, and deliberately moved the box.
书名号：英文中没有书名号 《》，用斜体表示书名：
- The title of Stephen R. Covey’s book is The 7 Habits of Highly Effective People.
英文书名或电影名改用中文表达时，双引号应改为书名号：
- 英文：He published an article entitled "The Future of the Aviation".
- 中文：他发表了一篇名为《航空业的未来》的文章。

长串数字	千分位	小数点	常用于
125,124,024.25	`,`	`.`	英美
125.124.024,25	`.`	`,`	欧洲
125 124 024,25		`,`	国际单位制（逗号地区）
125 124 024.25		`.`	国际单位制（句点地区）

其他符号

多空一格
运算符
- ✔️ 20 ± 2%、p < 0.01、1 + 1 = 2
- ❌ 20±2%、p<0.01、1+1=2
版权标识 ©
- ✔️ Copyright © 2021 LISIR 保留所有权利。
- ❌ Copyright©2021 LISIR 保留所有权利。
摄氏度符号与数字之间
- ✔️ 科学家通过分析卫星数据发现地球的最低温出现在南极东部高原，达到零下 100 °C。
- ❌ 科学家通过分析卫星数据发现地球的最低温出现在南极东部高原，达到零下 100°C。
不必空格
货币符号与数字之间
- ✔️ 一碗原味猪肉汤饭只要￥10。
- ❌ 一碗原味猪肉汤饭只要￥ 10。
百分号与数字之间
百分号（%）不是单位，因此应该紧挨在数字后面。
- ✔️ 去年营业额增长 5%
- ❌ 去年营业额增长 5 %
倍数与单位之间
- ✔️ 2x、3n
- ❌ 2 x、3 n

其他规范

时间

✔️ 12:05（半角冒号）
❌ 12:5（未补零）
❌ 12：5（全角冒号）

日期

样式一：

✔️ 2018-09-07（推荐）
✔️ 2018.09.07
❌ 2018-9-7

样式二：

✔️ 2018 年 9 月 7 日（简洁醒目）
✔️ 二零一八年九月七日（庄重典雅）
❌ 2018年09月07日

数字

农历月日：

✔️：腊月二十三、八月十五中秋节（选用汉字数字）
❌：腊月23、8月15中秋节

阿拉伯数字与汉字数字同时使用：

如果一个数值很大，数值中的「万」和「亿」单位可以采用汉字数字，其余部分采用阿拉伯数字。例如：我国 1982 年人口普查人数为 10 亿零 817 万 5288 人
除上面情况之外的一般数值，不能同时采用阿拉伯数字与汉字数字。例如：108 可以写作「一百零八」，但不应写作以「1 百零 8」「一百 08」；4000 可以写作「四千」，但不应写作「4 千」

数值范围

表示区间时，保留两端的单位。

✔️ 梨园乡种植的巨风葡萄今年已经进入了丰产期，亩产 1000 公斤至 1500 公斤。（或用到）
⚠️ 梨园乡种植的巨风葡萄今年已经进入了丰产期，亩产 1000 公斤～ 1500 公斤。（浪纹号～）
❌ 梨园乡种植的巨风葡萄今年已经进入了丰产期，亩产 1000 ~ 1500 公斤。（波浪号 ~）
✔️ 此事件有 5% 至 10% 的可能性发生。
❌ 此事件有 5至10% 的可能性发生。
✔️ 56 mm ± 2 mm、（56 ± 2）mm、（56 ± 1）%
⚠️ 10 × 15 × 20 mm（特例）
⚠️ 10 mm × 15 mm × 20 mm（过于冗余？存疑）

有序列表

markdown

- ✔️ 在小数点后面空一格（参考 Markdown 的写法）
  1. 静音
  2. 关机
  3. 睡觉

- ❌ 未在小数点后空一格
  1.静音
  2.关机
  3.睡觉

markdown

- ✔️ 顿号后面不用空一格
  1、静音
  2、关机
  3、睡觉

- ❌ 顿号后面空一格
  1、 静音
  2、 关机
  3、 睡觉

电话号码

✔️ 156 1024 1024（3-4-4 的格式，方便记忆和拨号）
❌ 15610241024

首行顶格

段落首行缩进 2 个字符是纸媒时代的旧习，文章的排版像狗啃了一样
在数字时代（特别是在移动端）
- 首行顶格
- 段落之间用空行隔开

争议之处

列表句末不加分号或句号
提示
- ✔️
  - 早上吃鸡蛋和水果
  - 中午吃蔬菜沙拉和鱼
  - 晚上吃番薯和一小碗饭
  - 睡前喝一瓶纯牛奶
- ❌
  - 早上吃鸡蛋和水果；
  - 中午吃蔬菜沙拉和鱼；
  - 晚上吃番薯和一小碗饭；
  - 睡前喝一瓶纯牛奶。
- 📝（长句例外）
  - 人生第一境界：昨夜西风凋碧树。独上高楼，望尽天涯路。
  - 人生第二境界：衣带渐宽终不悔，为伊消得人憔悴。
  - 人生第三境界：众里寻他千百度。蓦然回首，那人却在，灯火阑珊处。
直角引号代替双引号
提示
- 理由：
  - “蝌蚪”引号在数字世界容易渲染出错，是半角还是全角？是英文还是中文，飘忽不定。
  - 直角引号与方块字（汉字）更契合，但并未不是国标和主流排版届的共识。
  - 克制使用引号，避免句子被切得太碎。
- 输入：
  - ✔️ 如何输入「直角引号」？
  - ❌ 如何输入“直角引号”？
- 注意：
  - 当引号表示讽刺、反语暗示时，使用弯引号：工作使我“快乐”。
  - 『』为二级引号，即「」是最外层的引号。
Ta 们
提示
虽然「他们」在表达上可以泛指男女，但在形式上给人单指男性的印象，推荐使用 他（她）们 / ta 们 / Ta 们 / TA 们 泛指自己和对方以外的若干人
- ✔️ 将来我们有了孩子，给他（她）取名字一定不能草率了。
- ✔️ 将来我们有了孩子，给 Ta 取名字一定不能草率了。
其他 VS 其它：
- 其他：指人
- 其它：指事件、物、地方等
少用斜体
西文中有两种形状倾斜的字体：Oblique type 和 Italic type，倾斜后字形也发生的变化的是「意大利体」（Italic Type），而单纯将原字体向右倾斜而没有形变的称为伪斜体（Oblique type）。中文（汉字）的斜体实际上都是单纯将字面从正方形改为平行四边形的“伪斜体”。传统排版中，汉字一般不使用斜体。电脑的普及给字体变形带来了极大方便，才将西文这一习惯延伸到中文。by 维基百科

风格指南

中文风格

好文章所具备的 3 个标志：

文字简单清晰
用词恰如其分
描写精准、服务主题

用词精确

指代明确

使用代词时（比如其、该、此、这等词），必须明确指代的内容，保证只有一个含义。

❌ 从管理系统可以监视中继系统和受其直接控制的分配系统。
✔️ 从管理系统可以监视两个系统：中继系统和受中继系统直接控制的分配系统。

用对 的、地、得

形容词＋的＋名词：她露出了开心的笑容。
副词＋地＋动词：她开心地笑了。
动词＋得＋副词：她笑得很开心。

变化程度

了 表示增量，到 表示定量。

增加到过去的两倍（过去为一，现在为二）
增加了两倍（过去为一，现在为三）

不能用 降低 N 倍 或 减少 N 倍 的表示法，要用 降低百分之几 或 减少百分之几。因为减少（或降低）一倍表示数值原来为一百，现在等于零。

用语正式

在我看来，好的文字应该是长命的，缓释的价值越多，文字越高级。高级的文字并不着力于哗众取宠的爆发，而是有与众不同的角度和观点。我们会本能的高估短期，而低估长期，文字的价值如是，生活工作也是。by 二爷（邱岳）

少用网络流行语或谐音词，比如「蓝瘦香菇」、「吃枣药丸」、「图样图森破」等，因为多年以后，晚辈可能无法领悟这些速朽的辞藻，例如：

Lady Gaga 的演唱会真是酷毙了，从没看过这么给力的表演！！！

不推荐只有特定人群才了解的语词，例如：

魔改（即做特殊的优化）。或者插入行话时，列出必要的解释。

此外还有：

粉丝：不要称呼喜欢我们的用户为「粉丝」，可以换成「用户」或「读者」。因为粉丝的说法显得不平等，而且很多人不喜欢这种称呼，它含有缺乏独立思考的意思。
你和您：在不是很正式或没有明确的个体指代对象的时候请用「你」，如文档、博客、群发的邮件等；在指代特定个体时请用「您」，如活动邀请函等。
不使用「温馨提示」一词。

表达干练

现在你看文件越来越厚，但里面包含的信息量越来越少。我们经常在我们开某一次会以后，出个什么文件，然后又组织好多人去辅导。按理说一般有文字阅读能力的人，有知识的人都应该能看明白，但事实上我们没有办法看明白，就因为这文件里包含着好多的词汇，它与它本身的含义是不一样的。

我们崇尚精练的文风。请在检查中把对表达意思没有明显作用的字、词、句删除，在不影响表达效果的前提下把文案长度减到最短。

单个句子的长度尽量保持在 20 个字以内。
20 个至 29 个字的句子，可以接受。
30～39 个字的句子，语义必须明确，才能接受。
多于 40 个字的句子，在任何情况下都不能接受。

例如：

❌ 本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
✔️ 本产品适用于多种体系结构。无论是由一台服务器（单一节点结构），还是由多台服务器（并行处理结构）进行动作控制，均可以使用本产品。

少用形容词：

❌ 此设备的使用必须在接受过本公司举办的正式的设备培训的技师的指导下进行。
✔️ 此设备必须在技师的指导下使用，且指导技师必须接受过由本公司举办的正式设备培训。

少用复合句：

尽量使用简单句和并列句：

❌ 那个昨天生病的人没有参加会议。
✔️ 他昨天生病了，没有参加会议。

少用连词：

连词用得过多，会影响句子的节奏和美感。

比如，清风徐来，水波不兴，这句话就暗含了因果关系，但我们写的时候，难道要写成，因为清风徐来，所以水波不兴吗？

再比如，秦末天下大乱，群雄并起，这句话也暗含了因果关系，按照中文写作的习惯，没有必要写成，由于秦末天下大乱，群雄并起。by 涵柏

少用万能动词：

比如造成、进行这样的弱动词：

❌ 飞机失事，造成一百多人死亡。
✔️ 飞机失事，死了一百多人。

结构清晰

多用主动语态：

中文的正常表达，是主语 + 动词 + 名词，要改变句式顺序，一定要有特别的原因。例如强调主语不如意或遇到出乎意料的情况。

❌ 蛇把小王咬了。
✔️ 小王被蛇咬了。

因为蛇和我们并不同类，很难引起我们的共鸣，把小王放在主语位置，既突出了小王的不如意，也能让读者有一种强烈的代入感。

想写一篇文章，谈快餐对中国文化的影响：

❌ 中国人越来越喜欢快餐……
✔️ 快餐逐渐被中国人喜欢……

因为文章主旨就是为了强调快餐。

更多的例子如下：

❌ 假如此软件尚未被安装……
✔️ 假如尚未安装这个软件……
❌ 他被选为议长。
✔️ 他当选为议长。

多用肯定句：

同样一个意思，尽量使用肯定句表达，不使用否定句表达。

❌ 请确认没有接通装置的电源。
✔️ 请确认装置的电源已关闭。

少用双重否定句：

❌ 没有删除权限的用户，不能删除此文件。
✔️ 用户必须拥有删除权限，才能删除此文件。

英文风格

复数

英文原文如果使用了复数形式，翻译成中文时，应该将其还原为单数形式。

英文：⋯information stored in random access memory (RAMs)⋯
中文：……存储在随机存取存储器（RAM）里的信息……

缩写

第一次出现英文词汇时，在括号中给出中文标注。此后再次出现时，直接使用英文缩写即可。

IOC（International Olympic Committee，国际奥林匹克委员会）。这样定义后，便可以直接使用「IOC」了。

译名

品牌、产品名、人名、地名等特殊名词，如果来自英文，请使用英文以避免在不同译法之间选择。

文档名称

文档的文件名不得含有空格。
文件名建议只使用小写字母，不使用大写字母（可以提高打字速度）。
- ❌ TroubleShooting.md
- ✔️ troubleshooting.md 📝 为了醒目，某些说明文件的文件名，可以使用大写字母，比如README、LICENSE。
文件名包含多个单词时，单词之间建议使用半角的连字符（-）分隔。
- ❌ advanced_usage.md
- ✔️ advanced-usage.md

文章结构

原则

一个段落只表达一个主题。
- 段首：用一个中心句点题，对全段内容进行概述。
- 段中：为核心句服务。
- 段尾：扣题。
一个段落的长度不能超过七行，最佳段落长度小于等于四行。

文章引言

文章引言非常重要。它的作用主要是用于网站首页展示和微博分享，它是为了吸引读者阅读文章而存在，它的目的是让读者能够仅通过这一小段话，就能迅速了解到这篇文章的大致内容。因此，引言实际就是文章的「内容概要」，而非文章的开头首段。

我们建议通常在写完整篇文章后，再结合内容大纲撰写引言。引言务必要讲清两个问题：

是什么？（例如：这是一款什么应用？这篇文章是讲的什么？）
为什么？（例如：这款应用之所以被推荐，是由于它有哪些特色/亮点？）

引言的语言文字务必要清晰、直观、简洁，通常字数需控制在 90 字左右。

Markdown使用教程 推荐 ​

Markdown使用教程 ​

十、图片 ​

图片宽高 ​

TODO 待办列表 ​

内容居中容器 ​

Markdown 拓展 ​

内容居右容器 ​

笔记容器 ​

Video 容器 ​

五、文本 ​

段落 ​

字体 ​

删除线 ​

下划线 ​

文字高亮 ​

分隔线 ​

脚注 ​

六、列表 ​

无序列表 ​

带复选框列表 ​

列表嵌套 ​

七、区块引用 ​

区块嵌套 ​

区块中使用列表 ​

列表中使用区块 ​

八、代码 ​

九、链接 ​

变量链接 ​

Github仓库中使用内部链接 ​

十一、表格 ​

十二、Emoji表情包 ​

十三、其他技巧 ​

支持的 HTML 元素 ​

转义 ​

图表 ​

流程图 ​

时序图 ​

甘特图 ​

五、文本 ​

段落 ​

字体 ​

删除线 ​

下划线 ​

文字高亮 ​

分隔线 ​

脚注 ​

六、列表 ​

无序列表 ​

有序列表 ​

带复选框列表 ​

列表嵌套 ​

七、区块引用 ​

区块嵌套 ​

区块中使用列表 ​

八、代码 ​

代码区块 ​

九、链接 ​

变量链接 ​

十、图片 ​

图片宽高 ​

相对路径以及Github中使用图片 ​

十一、表格 ​

十二、Emoji表情包 ​

十三、其他技巧 ​

支持的 HTML 元素 ​

转义 ​

Markdown | 入门教程 ​

优势 ​

易学易记 ​

专注写作 ​

格式统一 ​

向外兼容 ​

入门 ​

进阶 ​

标题 ​

列表 ​

无序列表 ​

有序列表 ​

嵌套列表 ​

Markdown使用教程推荐

Markdown使用教程

十、图片

图片宽高

TODO 待办列表

内容居中容器

Markdown 拓展

内容居右容器

笔记容器

Video 容器

五、文本

段落

字体

删除线

下划线

文字高亮

分隔线

脚注

六、列表

无序列表

带复选框列表

列表嵌套

七、区块引用

区块嵌套

区块中使用列表

列表中使用区块

八、代码

九、链接

变量链接

Github仓库中使用内部链接

十一、表格

十二、Emoji表情包

十三、其他技巧

支持的 HTML 元素

转义

图表

流程图

时序图

甘特图

五、文本

段落

字体

删除线

下划线

文字高亮

分隔线

脚注

六、列表

无序列表

有序列表

带复选框列表

列表嵌套

七、区块引用

区块嵌套

区块中使用列表

八、代码

代码区块

九、链接

变量链接

十、图片

图片宽高

相对路径以及Github中使用图片

十一、表格

十二、Emoji表情包

十三、其他技巧

支持的 HTML 元素

转义

Markdown | 入门教程

优势

易学易记

专注写作

格式统一

向外兼容

入门

进阶

标题

列表

无序列表

有序列表

嵌套列表