6.8. markdown 语法上手（先学这 8 种） | 写作技巧 |《社区文档撰写指南》| learnku 产品论坛-金年会app官方网

概述

markdown 是程序员必学技能之一，然而有时其丰富多样的语法却让新人望而生畏。

此篇文章作为 markdown 上手教程，只教授你 8 个最常用的语法，记住这几个语法以后，就可以在你每篇文章中践行。等具备足够的使用经验后，再进一步学习 完整的 markdown 语法。

1. 标题

语法格式：'#' '空格' '文本'

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

图例：

注：

1. # 和标题之间建议保留一个字符的空格，这是最标准的 markdown 写法；
2. 一般情况下，文章的标题会被系统渲染为『一级标题』，所以请避免在文章内容中使用『一级标题』。
3. 请善用二级和三级标题，learnku 文章模块会自动为您生成 toc，这会让文章结构更加清晰，如下：
   

2. 列表

列表格式也很常用，在 markdown 中，你只需要在文字前面加上 - 就可以了，例如：

- 文本一
- 文本二
- 文本三

如果你希望有序列表，也可以在文字前面加上 1. 2. 3. 就可以了，例如：

1. 文本一
2. 文本二
3. 文本三

图例：

3. 链接和图片

在 markdown 中插入链接需要使用 [显示文本](链接地址) 这样的格式语法。例如：

[learnku 开发者社区](https://learnku.com)

在 markdown 中，插入图片不需要其他按钮，你只需要使用 ![](图片链接地址) 这样的语法即可，例如：

![](https://iocaffcdn.phphub.org/uploads/images/201806/12/1/owic58yjaw.jpeg?imageview2/2/w/1240/h/0)

注：插入图片的语法和链接的语法很像，只是前面多了一个 !。

图例：

learnku 上图片显示时会加阴影，如果你想去除阴影的话，可以使用以下方式：

图例：

注：learnku 编辑器上传图片，只需要将图片拖拽丢入『编辑窗口』内，或者复制图片在『编辑窗口』内黏贴即可上传。

4. 引用

写作时经常需要引用他人的文字，在 markdown 中，你只需要在你希望引用的文字前面加上 > 即可，例如：

markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的 html 页面。

图例：

5. 行内代码

行内的代码使用 ` 包起来即可，一般在描述类、函数、文件名称及路径时使用，如：

laravel 框架的所有配置文件都保存在 `config` 目录中。可以使用 `config()` 辅助函数来读取。

图例：

6. 代码高亮

如下是代码段的语法：

```编程语言
 这是代码段
```

例如：

```php
class order extends model
{
   ...
   public function scopedelivered($query) {
      return $query->where('status', 'delivered');
   }
   public function scopepaid($query) {
      return $query->where('paid', true);
   }
}
$orders = order::delivered()->paid()->get();
```

图例：

注：在 learnku 上，每一个社区都设定了默认的代码高亮语法，例如 php 和 laravel 社区默认使用 php 作为默认高亮语法，当你只使用 ``` 而未设置语法时，此功能会被用上。

7. 粗体和斜体

markdown 的粗体和斜体非常简单，用两个 * 包含一段文本就是粗体的语法，用一个 * 包含一段文本就是斜体的语法。例如：

markdown 的 **粗体** 和 *斜体* 非常简单。

最终显示的就是下文：

markdown 的 粗体 和 斜体 非常简单。

图例：

8. 表格

基础的表格语法：

项目 | 价格
-------- | ---
iphone | $560
ipad | $780
imac | $1000

可以使用冒号来定义对齐方式：

| 项目 | 价格 | 数量 |
| :-------- | --------:| :--: |
| iphone | 6000 元 | 5 |
| ipad | 3800 元 | 12 |
| imac | 10000 元 | 234 |

图例：

结语

markdown 编写是开发者的必备技能，尤其在撰写技术文档上，更加离不开 markdown 语法。如果对 markdown 语法不熟悉，本篇文章罗列了使用频率最高的 8 个语法，你可以多看几遍，或者打开 直接尝试，这样会记得更加牢固。

在掌握了以上的简单语法后，推荐查阅 完整 markdown 语法。