转载自：Laravel 社区
排版规范
排版整洁对一篇文章来说非常重要
- 英文专有名词首字母需要大写；
- 英文的左右 必须 保有一个空白，避免中英文黏在一起；
- 中文 必须 使用全角标点符号；
- 必须 严格准守 Markdown 语法；
- 「
加亮」和 「加粗」 和 「链接]()」 都需要在左右保持一个空格； - 篇幅较长的代码里，请多使用代码注释；
- 中文与数字之间需要增加空格，数字与单位之间需要增加空格；
今天出去买菜花了 5000 元。我家的光纤入屋宽频有 10 Gbps，SSD 一共有 20 TB
控制文章长度
- 相比简短的文章，用户无法获取到更多 成就感，读起来累；
- 学习难度增加，读者很容易放弃，或者跟不上；
- 需要占用的时间过长，中途易被打断。
但是也不能片面地理解为文章越短越好，应该是将保持 文章最合适的长度。
一个参考的标准是，浏览器里按一次 空格键 就是一屏幕的长度：
- 图文内容的文章，一般不超过 10 个屏幕；
- 文字偏多的文章，一般不超过 5 个屏幕。
Markdown 语法
概述
Markdown 是程序猿必须技能之一，然后丰富多样的语法却让新手望而生畏。
1. 标题
语法格式：'#'+'空格'+'文本'
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
注：
#和标题之间建议保留一个字符的空格，这是最标准的 Markdown 写法；- 一般情况下，文章的标题会被系统渲染为『一级标题』，所以请避免在文章内容中使用『一级标题』。
2. 列表
列表格式也很常用，在 Markdown 中，你只需要在文字前面加上 - 就可以了，例如：
- 文本一
- 文本二
- 文本三
如果你希望有序列表，也可以在文字前面加上 1. 2. 3. 就可以了，例如：
1. 文本一
2. 文本二
3. 文本三
3. 链接和图片
在 Markdown 中插入链接需要使用 [显示文本](链接地址) 这样的格式语法。例如：
[LearnKu 开发者社区](https://learnku.com)
在 Markdown 中，插入图片不需要其他按钮，你只需要使用 [图片上传失败...(image-ae42eb-1604300076178)] 这样的语法即可，例如：
注：插入图片的语法和链接的语法很像，只是前面多了一个
!。
4. 引用
写作时经常需要引用他人的文字，在 Markdown 中，你只需要在你希望引用的文字前面加上 > 即可，例如：
Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的 HTML 页面。
5. 行内代码
行内的代码使用 『`』 包起来即可，一般在描述类、函数、文件名称及路径时使用，如：
Laravel 框架的所有配置文件都保存在 `config` 目录中。可以使用 `config()` 辅助函数来读取。
6. 代码高亮
如下是代码段的语法：
```编程语言
这是代码段
`` `
例如：
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作为默认高亮语法，当你只使用 <code>```</code> 而未设置语法时，此功能会被用上。
7. 粗体和斜体
Markdown 的粗体和斜体非常简单，用两个 * 包含一段文本就是粗体的语法，用一个 * 包含一段文本就是斜体的语法。例如：
Markdown 的 **粗体** 和 *斜体* 非常简单。
最终显示的就是下文：
Markdown 的 粗体 和 斜体 非常简单。
8. 表格
基础的表格语法：
项目 | 价格
-------- | ---
iPhone | $560
iPad | $780
iMac | $1000
可以使用冒号来定义对齐方式：
| 项目 | 价格 | 数量 |
| :-------- | --------:| :--: |
| iPhone | 6000 元 | 5 |
| iPad | 3800 元 | 12 |
| iMac | 10000 元 | 234 |
| 项目 | 价格 | 数量 |
|---|---|---|
| iPhone | 6000 元 | 5 |
| iPad | 3800 元 | 12 |
| iMac | 10000 元 | 234 |
结语
Markdown 编写是开发者的必备技能，尤其在撰写技术文档上，更加离不开 Markdown 语法。如果对 Markdown 语法不熟悉，本篇文章罗列了使用频率最高的 8 个语法，你可以多看几遍，或者打开 编辑器 直接尝试，这样会记得更加牢固。
在掌握了以上的简单语法后，推荐查阅 完整 Markdown 语法。
网友评论