语法示例
剪切线
***
或
---
或
___效果
_
普通表格
|Author|LJH|
|---|---
|E-mail|ljh@ljhyun.com效果
| Author | LJH |
|---|---|
| ljh@ljhyun.com |
文字带连接
[点我跳转网页](https://ljhyun.com)效果
目录
## 目录
* [语法示例](#语法示例)
* [剪切线](#剪切线)
* 文本
* 普通文本
* 单行文本
* 多行文本效果
目录
标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题 效果
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
文本
普通文本
这是一段普通的文本
单行文本
Hello,大家好。在一行开头加入1个Tab或者4个空格。
文本块
语法1
在连续几行的文本开头加入1个Tab或者4个空格。
欢迎到访
很高兴见到您
祝您,早上好,中午好,下午好,晚安
语法2
使用一对各三个的反引号:
欢迎到访
我是C++码农
你可以在知乎、CSDN、简书找到我该语法也可以实现代码高亮
在三个反引号后面加上编程语言的名字,另起一行开始写代码,最后一行再加上三个反引号。
public static void main(String[]args){} //Javaint main(int argc, char *argv[]) //Cecho "hello GitHub" #Bashdocument.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javasciptstring &operator+(const string& A,const string& B) //cpp文字高亮
文字高亮功能能使行内部分文字高亮,使用一对反引号。
语法:
`linux` `网络编程` `socket` `epoll` 效果:linux 网络编程 socket epoll
也适合做一篇文章的tag
换行
直接回车不能换行,
可以在上一行文本后面补两个空格,
这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果,不过这个行间距有点大。
斜体、粗体、删除线
| 语法 | 效果 |
|---|---|
*斜体1* | 斜体1 |
_斜体2_ | 斜体2 |
**粗体1** | 粗体1 |
__粗体2__ | 粗体2 |
这是一个 ~~删除线~~ | 这是一个 |
***斜粗体1*** | 斜粗体1 |
___斜粗体2___ | 斜粗体2 |
***~~斜粗体删除线1~~*** | |
~~***斜粗体删除线2***~~ |
斜体、粗体、删除线可混合使用
图片&链接
基本格式:
alt和title即对应HTML中的alt和title属性(都可省略):
- alt表示图片显示失败时的替换文本
- title表示鼠标悬停在图片时的显示文本(注意这里要加引号)
URL即图片的url地址,如果引用本仓库中的图片,直接使用相对路径就可了,如果引用其他github仓库中的图片要注意格式,即:仓库地址/raw/分支名/图片路径,如:
http://www.baidu.com/img/bdlogo.gif| # | 语法 | 效果 |
|---|---|---|
| 1 |  | ![]() |
| 2 | [网址导航][ljhyun] | 网址导航 |
| 3 | [我的简介](/example/profile.md) | 我的简介 |
注意:
例1是用于图片的
例2用于外部链接。
例3用于站内链接。
在文末有ljhyun的定义:
[ljhyun]:https://ljhyun.com一般把全文所有的URL标识符统一放在文章末尾,这样看起来比较干净.
图片链接
给图片加链接的本质是混合图片显示语法和普通的链接语法。普通的链接中[ ]内部是链接要显示的文本,而图片链接[ ]里面则是要显示的图片。
直接混合两种语法当然可以,但是十分啰嗦,为此我们可以使用URL标识符的形式。
| # | 语法 | 效果 |
|---|---|---|
| 1 | [![ljhyunLogo1]](https://www.ljhyun.com/img/favicon.ico) | [![ljhyunLogo1]](https://www.ljhyun.com/img/favicon.ico) |
| 2 | [][ljhyunLogo1] | |
| 3 | [![ljhyunLogo1]][ljhyunLogo] | [![ljhyunLogo1]][ljhyunLogo] |
因为图片本身和链接本身都支持URL标识符的形式,所以图片链接也可以很简洁(见例3)。
注意,此时鼠标悬停时显示的文字是图片的title,而非链接本身的title了。
锚点
其实呢,每一个标题都是一个锚点,和HTML的锚点(#)类似,比如我们
| 语法 | 效果 |
|---|---|
[回到顶部](#语法示例) | 回到顶部 |
列表
无序列表
### 无序列表
* 昵称:123
- 别名:321
* 英文名:213效果
无序列表
- 昵称:123
- 别名:321
- 英文名:213
多级无序列表
### 多级无序列表
* 编程语言
* 脚本语言
* Python效果
多级无序列表
编程语言
脚本语言
- Python
有序列表
就是在数字后面加一个点,再加一个空格。不过看起来起来可能不够明显。
面向对象的三个基本特征:
1. 封装
2. 继承
3. 多态效果
- 封装
- 继承
- 多态
多级有序列表
和无序列表一样,有序列表也有多级结构:
1. 这是一级的有序列表,数字1还是1
1. 这是二级的有序列表,阿拉伯数字在显示的时候变成了罗马数字
1. 这是三级的有序列表,数字在显示的时候变成了英文字母效果
这是一级的有序列表,数字1还是1
这是二级的有序列表,阿拉伯数字在显示的时候变成了罗马数字
- 这是三级的有序列表,数字在显示的时候变成了英文字母
复选框列表
- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
- [ ] 编码
- [ ] 测试
- [ ] 交付效果
- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
- [ ] 编码
- [ ] 测试
- [ ] 交付
可以使用这个功能来标注某个项目各项任务的完成情况。
Tip:在GitHub的issue中使用该语法是可以实时点击复选框来勾选或解除勾选的,而无需修改issue原文。
块引用
常用于引用文本,块引用有多级结构
> 数据结构
>> 树
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树效果
数据结构
树
二叉树
平衡二叉树
满二叉树
表格
表头1 | 表头2|
--------- | --------|
表格单元 | 表格单元 |
表格单元 | 表格单元 |
| 表头1 | 表头2|
| ---------- | -----------|
| 表格单元 | 表格单元 |
| 表格单元 | 表格单元 |效果
| 表头1 | 表头2 | |
|---|---|---|
| 表格单元 | 表格单元 | |
| 表格单元 | 表格单元 |
| 表头1 | 表头2 |
|---|---|
| 表格单元 | 表格单元 |
| 表格单元 | 表格单元 |
对齐
表格可以指定对齐方式:
| 左对齐 | 居中 | 右对齐 |
| :------------ |:---------------:| -----:|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |效果
| 左对齐 | 居中 | 右对齐 |
|---|---|---|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
混合其他语法
表格单元中的内容可以和其他大多数GFM语法配合使用,如:
使用普通文本的删除线,斜体等效果
| 名字 | 描述 |
| ------------- | ----------- |
| Help | ~~Display the~~ help window.|
| Close | _Closes_ a window |效果
| 名字 | 描述 |
|---|---|
| Help | |
| Close | Closes a window |
表格中嵌入图片(链接)
其实前面介绍图片显示、图片链接的时候为了清晰就是放在在表格中显示的。
| 图片 | 描述 |
| ---- | ---- |
| | 网址导航|效果
| 图片 | 描述 |
|---|---|
| 网址导航 |
表情
Github的Markdown语法支持添加emoji表情,输入不同的符号码(两个冒号包围的字符)可以显示出不同的表情。
比如:blush:,可以显示:blush:。
具体每一个表情的符号码,可以查询GitHub的官方网页http://www.emoji-cheat-sheet.com。
但是这个网页每次都打开奇慢。。所以我整理到了本repo中,大家可以直接在此查看emoji。
diff语法
版本控制的系统中都少不了diff的功能,即展示一个文件内容的增加与删除。
GFM中可以显示的展示diff效果。使用绿色表示新增,红色表示删除。
其语法与代码高亮类似,只是在三个反引号后面写diff,
并且其内容中,以 + 开头表示新增,- 开头表示删除。
效果如下:
+ 鸟宿池边树,僧敲月下门
- 鸟宿池边树,僧推月下门
