github学习之旅(六)—— MarkDown
一、MarkDown是什么?
- 一种轻量级的、易于书写的、纯文本格式的语法,用来在互联网上书写带有格式的文档。
- 用来控制文档的样式,包括:文字的粗体、斜体,在文档中添加图片,创建列表,等等。
- MarkDown是由 John Gruber 和 Aaron Swartz 在2004年合作发明的,距今已有十多年的历史了。
二、标题
Markdown 中,只需要在文本前面加上“#”,就会被认为是加了一个标题。同理,你还可以增加二级、三级、四级、五级标题和六级标题,只需要增加“#” 即可。例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
显示效果:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
三、段落
换行
在markdown中,直接换行是没用的,比如:
“
所有的结局都已写好
所有的泪水也都启程
”
写好的格式是这样,但是有时会显示成
“
所有的结局都已写好所有的泪水也都启程
”
也就是一排显示,这时只需要在俩行中间敲一下enter,即可换行,但是此时俩行中间间距略微偏多,这时可以在第一行末尾,敲俩个空格,也可实现效果。
缩进
在markdown中缩进:
- 半方大的空白 或 
- 全方大的空白 或 
- 不断行的空白格 或 
四、列表
当你要罗列一些内容时,列表是很有用的工具。为了说明哪些条目属于这个列表,我们需要引入“项目标记”。
列表项目标记通常放在段落开头,后面要跟着一个空格。列表的各个条目之间可以不留空行。
无序列表
若列表中的条目没有特定顺序时,可以使用 无序列表。加号“+”或减号“-”都可以作为列表标记,后面要跟一个空格。例如:
+ 苹果
+ 橘子
+ 梨子
或者:
- 苹果
- 橘子
- 梨子
显示效果:
-
苹果
-
橘子
-
梨子
有序列表
若想在段落前加上数字序号,就需要用到有序列表了。使用数字、一个英文句号和一个空格即可。例如:
1. 苹果
2. 橘子
3. 梨子
显示效果:
-
苹果
-
橘子
-
梨子
多级列表
五、图片
Markdown 中可以插入图片,只需要感叹号、方括号和圆括号即可。例如:
![text](Picture address)
一个英文感叹号 “!” 后紧跟方括号,里面可以写这张图片的说明;再紧跟一对圆括号,里面写这张图片的网址。例如:
显示效果:
当然,如果你只是想单纯上传一张图片,不想有文字描述,把文字去掉就可以了:
显示效果:
六、链接
在文档中插入连接的语法和插入图片的语法很像,只是少了最前面的英文感叹号"!"。
在方括号写下链接文字,圆括号写下网址即可。
外部链接
[这是简书的首页](https://www.jianshu.com/)
显示效果:
内部链接1
链接到仓库中(github)的其他文件:
[demo1](demo1.md)
显示效果:
demo1
点击的话会跳转到demo1.md文件
内部链接2
链接到本文档的其他部分(类似于html的锚点)
[代码块 demo](demo2.md#代码块-demo)
效果:
代码块 demo
引用式链接
这个链接就是在文档某处(一般是文档尾部),定义好,用的地方直接使用:
<!--下面是本文档中可能用到的链接-->
[简书]:https://www.jianshu.com
使用时,直接书写 “[百度]” 即可实现链接效果
七、强调
在Markdown中,可以使用 * 和 _ 来表示斜体和加粗。需要注意的是,“_”是下划线而非减号“-”。
斜体
在需要斜体的文本左右各加一个“*”或“_” ,例如:
*所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。*
_所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。_
显示效果:
所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。
加粗
在需要加粗的文本左右各加两个“*”或“_” ,例如:
**所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。**
__所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。__
显示效果:
所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。
斜体并加粗
在需要斜体并加粗的文本左右各加三个“*”或“_” ,例如:
***所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。***
___所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。___
显示效果:
所谓美好的心灵,就是能体贴万物的心,能温柔对待一草一木的心灵。
删除线
在文字俩旁各加2个 “~” 即可实现删除线的效果:
~~¥199.00~~
显示效果:
¥199.00
八、引用
可以使用">" 标记来引用其他人的言论、书籍或报纸的内容。只需要在段落的第一行最前面加上 > 即可,例如:
> 青春不是玫瑰,青春是伏特加酒,看起来不怎么样,喝光的时候,才知道它的后劲满强。 —— 林清玄 《你心柔软,却有力量》
显示效果:
青春不是玫瑰,青春是伏特加酒,看起来不怎么样,喝光的时候,才知道它的后劲满强。 ——林清玄 《你心柔软,却有力量》
在引用的区域内,也可以使用其他的 Markdown 语法,包括标题、列表等,例如:
> *青春不是玫瑰,青春是伏特加酒,看起来不怎么样,喝光的时候,才知道它的后劲满强。* ——林清玄 《你心柔软,却有力量》
显示效果:
青春不是玫瑰,青春是伏特加酒,看起来不怎么样,喝光的时候,才知道它的后劲满强。 ——林清玄 《你心柔软,却有力量》
九、分割线
在 Markdown 中,可以用分隔线来将内容分成不同区域。
这里有三种写法,三个“-”、三个“*”、三个“_”,都可实现分割线的效果:
- ---
- ***
- ___
显示效果都是:
简书中编辑代码
在markdown中编辑代码段,分为块式代码和行内代码
块式代码
可以切换英文输入法,开头和结尾各打三个 “ ``` ”,即可,例如:
```
let add = ( ...val )=>{ // 不定参数求和
var result = 0;
for( var i = 0; i < val.length; i++ ){
result += val[i];
}
return result;
}
console.log( add( 100, 200 ) ); // 300
```
显示效果:
let add = ( ...val )=>{ // 不定参数求和
let result = 0;
for( let i = 0; i < val.length; i++ ){
result += val[i];
}
return result;
}
console.log( add( 100, 200 ) ); // 300
行内代码
代码的开头和结尾各打一个 "`" 即可:
我们如果要在浏览器中弹出信息,可以使用`alert( " hello " )`。
效果:
我们如果要在浏览器中弹出信息,可以使用alert( " hello " )
十、表格
表格有时是挺有用的,这里讲解一下,一个基础的表格实现方式:
| 姓名 | 年龄 | 性别 |
| ----- | ----- | ----- |
| tom | 23 | 男 |
| jack | 18 | 男 |
| alice | 22 | 女 |
效果:
姓名 | 年龄 | 性别 |
---|---|---|
tom | 23 | 男 |
jack | 18 | 男 |
alice | 22 | 女 |
这里可以定义表格的对齐方式,分别是居左对齐(默认)、居中对齐、居右对齐,实现方式就是: |
| 姓名 | 年龄 | 性别 |
| :----- | :-----: | -----: |
| tom | 23 | 男 |
| jack | 18 | 男 |
| alice | 22 | 女 |
也就是在不同的位置加冒号,效果:
姓名 | 年龄 | 性别 |
---|---|---|
tom | 23 | 男 |
jack | 18 | 男 |
alice | 22 | 女 |
十一、表情
经测试,github是支持添加emoji表情的,输入不同的符号码(俩个冒号包围的字符),可以显示出不同的表情,比如笑脸:
😄
以下是部分表情:
十二、复杂场景的实现
图片链接
一张图片链接到百度
[![](https://www.baidu.com/img/bd_logo1.png)](https://www.baidu.com)
效果:
混合强调样式
- ***加粗倾斜***
- **~~加粗删除~~**
- ***~~加粗倾斜删除~~***
效果:
- 加粗倾斜
加粗删除加粗倾斜删除