Markdown使用说明

公司新增的产品中用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. 有序列表1
  2. 有序列表2
  3. 有序列表3

链接

插入链接的语法是[显示文本](链接地址)。例如:

[知乎](https://www.zhihu.com/)

具体效果如下:

知乎

图片

插入图片与插入链接的语法很像,语法为![](图片链接地址),只是多了一个感叹号,其中感叹号是英文的,[方括号]标记图片的替代文字,[方括号]内可以不写文字,但[方括号]一定要带着,相当于图片的alt描述。例如:

![王子](http://note.youdao.com/yws/public/resource/118d9f64ac08c5f323820756ef7d19ce/xmlnote/16571CBE3D034D419772CE255FE3294C/959g)

具体效果如下:


王子

表格

表格的语法相对复杂一点,不过使用习惯就好了,关键是理解语法的含义,语法如下。例如:

| 一个普通标题 | 一个普通标题 | 一个普通标题 |
| ------ | ------ | ------ |
| 短文本 | 中等文本 | 稍微长一点的文本 |
| 稍微长一点的文本 | 短文本 | 中等文本 |

注意我们在使用的时候不需要保证 | 非得要对齐,多余的空格会被自动忽略掉。不然有强迫症的同学肯定会疯掉。

具体效果如下:

普通标题 普通标题 普通标题
短文本 中等文本 稍微长一点的文本
稍微长一点的文本 短文本 中等文本

如果需要设置对齐,需要下面的格式来书写。语法说明如下:

  1. |、-、:之间的多余空格会被忽略,不影响布局。

  2. 默认标题栏居中对齐,内容居左对齐。

  3. -:表示内容和标题栏居右对齐,:-表示内容和标题栏居左对齐,:-:表示内容和标题栏居中对齐。

  4. 内容和|之间的多余空格会被忽略,每行第一个|和最后一个|可以省略,-的数量至少有一个。

| 左对齐标题 | 右对齐标题 | 居中对齐标题 |
| :------| ------: | :------: |
| 短文本 | 中等文本 | 稍微长一点的文本 |
| 稍微长一点的文本 | 短文本 | 中等文本 |

具体效果如下:

左对齐标题 右对齐标题 居中对齐标题
短文本 中等文本 稍微长一点的文本
稍微长一点的文本 短文本 中等文本

代码引用

需要引用代码时,如果引用的语句只有一段,不分行,可以用 ` 将语句前后包起来。

具体效果如下:

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的简洁和易用,效率也自然提升。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容

  • 认识Markdown Markdown的理念是,能让文档更容易读、写和随意改。使用其他常见的富文本编辑器,您可能需...
    刑素素阅读 1,282评论 0 0
  • markdown -- 易读易写 Foo this is an H1 this is an H2 ps. = 表...
    Eric苏离阅读 370评论 0 1
  • 为什么学习Markdown 自从搭建了 Hexo 博客之后,发现还有 Markdown 这种写文章的方法,想到以后...
    lifeColder阅读 20,130评论 10 217
  • Markdown 语法说明 概述宗旨兼容HTML 区块元素段落和换行标题区块引用列表代码区块表格分割线删除线 区段...
    咚呱阅读 915评论 1 2
  • 平凡如我,却也不甘过一眼望得到尽头的人生。对未来抱有期待,该是对生活最起码的尊重。 九月,清晨,湛...
    lucky雪晴阅读 303评论 0 0