公司新增的产品中用Markdown来编写产品更新日志,怎么在团队中介绍和推广Markdown的使用落到我身上。就简单地写了一点,顺便也在简书上复制一份吧。
认识Markdown
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。Markdown的理念是,能让文档更容易读、写和随意改。
使用Markdown来写作自己的文稿,可以节省大量的时间,不需要耗费精力在调整格式标签上。而且Markdown的语法也十分简单。常用的标记符号也不超过十个,学习成本不需要太多。下文会会结合我们的具体使用场景,介绍Markdown的主要语法。
Markdown常用语法介绍
标题
在 Markdown中,如果一段文字被定义为标题,只要在这段文字前加#号即可。Markdown总共有六级标题,使用方式为在编辑器中输入#键,在#号后加一个字符的空格,然后输入标题名称即可;如果是二级标题就需要输入两个#,依次类推。注意#和文字之间需要保留一个空格的字符,否则显示会有问题。例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
###### 五级标题
###### 六级标题
具体效果如下:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
粗体
Markdown 的粗体非常简单,用两个*包含一段文本就是粗体的语法。 例如:
**这里是粗体语法**
具体效果如下:
这里是粗体语法
斜体
Markdown 的斜体的使用方式也非常简单,用一个 *包含一段文本就是斜体的语法。例如:
*这里是斜体语法*
具体效果如下:
这里是斜体语法
引用
如果你需要引用一小段别处的句子,那么就要用引用的格式,只需要在段落前加一个>就可以了。例如:
> 这里是引用的语法
具体效果如下:
这里是引用的语法
无序列表
列表的显示只需要在文字前加上 -或 *即可变为无序列表。 例如:
- 无序列表1
- 无序列表2
- 无序列表3
具体效果如下:
- 无序列表1
- 无序列表2
- 无序列表3
有序列表
有序列表直接在文字前加 1. 2. 3.就可以了。 例如:
1. 有序列表1
2. 有序列表2
3. 有序列表3
具体效果如下:
- 有序列表1
- 有序列表2
- 有序列表3
链接
插入链接的语法是[显示文本](链接地址)。例如:
[知乎](https://www.zhihu.com/)
具体效果如下:
图片
插入图片与插入链接的语法很像,语法为![](图片链接地址)
,只是多了一个感叹号,其中感叹号是英文的,[方括号]标记图片的替代文字,[方括号]内可以不写文字,但[方括号]一定要带着,相当于图片的alt描述。例如:
![王子](http://note.youdao.com/yws/public/resource/118d9f64ac08c5f323820756ef7d19ce/xmlnote/16571CBE3D034D419772CE255FE3294C/959g)
具体效果如下:
表格
表格的语法相对复杂一点,不过使用习惯就好了,关键是理解语法的含义,语法如下。例如:
| 一个普通标题 | 一个普通标题 | 一个普通标题 |
| ------ | ------ | ------ |
| 短文本 | 中等文本 | 稍微长一点的文本 |
| 稍微长一点的文本 | 短文本 | 中等文本 |
注意我们在使用的时候不需要保证 | 非得要对齐,多余的空格会被自动忽略掉。不然有强迫症的同学肯定会疯掉。
具体效果如下:
普通标题 | 普通标题 | 普通标题 |
---|---|---|
短文本 | 中等文本 | 稍微长一点的文本 |
稍微长一点的文本 | 短文本 | 中等文本 |
如果需要设置对齐,需要下面的格式来书写。语法说明如下:
|、-、:之间的多余空格会被忽略,不影响布局。
默认标题栏居中对齐,内容居左对齐。
-:表示内容和标题栏居右对齐,:-表示内容和标题栏居左对齐,:-:表示内容和标题栏居中对齐。
内容和|之间的多余空格会被忽略,每行第一个|和最后一个|可以省略,-的数量至少有一个。
| 左对齐标题 | 右对齐标题 | 居中对齐标题 |
| :------| ------: | :------: |
| 短文本 | 中等文本 | 稍微长一点的文本 |
| 稍微长一点的文本 | 短文本 | 中等文本 |
具体效果如下:
左对齐标题 | 右对齐标题 | 居中对齐标题 |
---|---|---|
短文本 | 中等文本 | 稍微长一点的文本 |
稍微长一点的文本 | 短文本 | 中等文本 |
代码引用
需要引用代码时,如果引用的语句只有一段,不分行,可以用 ` 将语句前后包起来。
具体效果如下:
Hello Word
如果引用的语句为多行,可以将```置于这段代码的首行和末行。
具体效果如下:
<!DOCTYPE html>
<html>
<body>
<?php
$cars=array("Volvo","BMW","HAVAL");
echo "I like " . $cars[0] . "," . $cars[1] . " and " . $cars[2] . ".";
?>
</body>
</html>
分隔线
分隔线的使用很简单,用---或者***就可以了。例如:
---
具体效果如下:
全屏模式
当你对Markdown的基本语法已经比较熟悉的时候,你就可以使用在全屏模式下编写文本,这样可以大大提高你的文本编写速度。
常见问题
换行问题
不同的编辑器中Markdown展现的效果不完全一致,同时部分厂商也有自己的语法,比如有的编辑器就支持待办事宜Todo列表和流程图等。
我们只要掌握最常见的语法,也就是上文提及的就完全可以应对绝大多数使用场景。
换行问题
Markdown对换行的语法规范是空格+空格+回车换行,也就是说,如果你要进行换行操作,你需要先按两次空格键,然后按一次回车键即可。
分段落问题
Markdown对分段的语法规范是按两次回车键,也就是说,如果你要进行分段操作,你只需要按两次回车键即可。当然,多次使用回车键的效果与按两次回车键的效果一样,并不会产生多余的空白行。
我们可以看到分段带来的间距要大于换行带来的间距,使用的时候要注意。
标签规范使用问题
规范的Markdown语法是,使用的标签和后面的文本要有一个字符的空格,否则可能在后台预览正常,但是前台却不会正常显示。
总结
熟悉以上这些Markdown的语法后,在日常使用中基本就没什么大问题了,只要多加练习使用起来就可以很快体会到Markdown的简洁和易用,效率也自然提升。