修改自果冻虾仁
Markdown语法
目录
横线
语法
***、—、___可以显示横线效果
***
---
___
效果
标题
语法
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
文本
普通文本
这是一段普通的文本
单行文本
语法
在一行开头加入1个Tab或者4个空格。
Hello,大家好,我是cyc。
效果
Hello,大家好,我是cyc。
文本块
语法1
在连续几行的文本开头加入1个Tab或者4个空格。
欢迎到访
很高兴见到您
祝您,早上好,中午好,下午好,晚安
效果
欢迎到访
很高兴见到您
祝您,早上好,中午好,下午好,晚安
语法2
使用一对各三个的反引号`
效果
欢迎到访
我是CYC
该语法也可以实现代码高亮,见代码高亮
文字高亮
文字高亮功能能使行内部分文字高亮,使用一对反引号。
语法
`linux` `网络编程` `socket` `epoll`
效果
linux
网络编程
socket
epoll
也适合做一篇文章的tag
文字颜色
语法
<font face="黑体">我是黑体字</font>
<font face="微软雅黑">我是微软雅黑</font>
<font face="STCAIYUN">我是华文彩云</font>
<font color=red>我是红色</font>
<font color=Blue>我是蓝色</font>
<font size=5>我是尺寸</font>
<font face="黑体" color=green size=5>我是黑体,绿色,尺寸为5</font>
<span style="color:purple">purple bar</span>
效果
我是黑体字 我是微软雅黑 我是华文彩云 我是红色 我是蓝色 我是尺寸 我是黑体,绿色,尺寸为5purple bar
换行
直接回车不能换行, 可以在上一行文本后面补两个空格, 这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果,不过这个行间距有点大。
斜体、粗体、删除线
语法 | 效果 |
---|---|
*斜体1* |
斜体1 |
_斜体2_ |
斜体2 |
**粗体1** |
粗体1 |
__粗体2__ |
粗体2 |
这是一个 ~~删除线~~ |
这是一个 |
***斜粗体1*** |
斜粗体1 |
___斜粗体2___ |
斜粗体2 |
***~~斜粗体删除线1~~*** |
|
~~***斜粗体删除线2***~~ |
斜体、粗体、删除线可混合使用
图片
本站图片/gif
语法
本站图片存于img
或img/post_img
中,网站中的路径为../../../../img
或../../../../img/post_img
<div align=center><img src="../../../../img/post_img/post1-uom.jpg" width="800"/></div>
效果
外站图片/gif
语法
<div id="header" align="center">
<img src="https://media.giphy.com/media/eMUXOAdxi8FzJU3qDe/giphy.gif" width="200"/>
</div>
效果
链接
文字链接
语法
来我的[GitHub](https://github.com/YechengChu)看看吧
效果
来我的GitHub看看吧
图片/Gif链接
语法
<div id="header" align="center">
<a href="https://www.manchester.ac.uk"><img src="https://media.giphy.com/media/7OQpC4XSFSNpuyCDNU/giphy.gif" width="170"/></a>
</div>
效果
锚点
其实呢,每一个标题都是一个锚点,和HTML的锚点(#
)类似,比如我们
语法 | 效果 |
---|---|
[回到顶部](#readme) |
回到顶部 |
注意⚠️:所有英文字母都__必须小写__,有空格的话用-
连接,如[Google Drive PDF](#google-drive-pdf)
注意⚠️:如果readme要生成html网页的话则不能使用#readme
,必须要改为#top
脚注
语法
Here is a simple footnote[^1].
Here is another footnote[^2].
[^1]: My reference.
[^2]: My footnote!
效果
Here is a simple footnote1.
Here is another footnote2.
列表
无序列表
语法
* 昵称:Hello
- 别名:Hi
效果
- 昵称:Hello
- 别名:Hi
多级无序列表
语法
* 编程语言
* 脚本语言
* Python
效果
- 编程语言
- 脚本语言
- Python
- 脚本语言
一级有序列表
语法
就是在数字后面加一个点,再加一个空格。不过看起来起来可能不够明显。
面向对象的三个基本特征:
1. 封装
2. 继承
3. 多态
效果
面向对象的三个基本特征:
- 封装
- 继承
- 多态
多级有序列表
和无序列表一样,有序列表也有多级结构。
语法
1. 这是一级的有序列表,数字1还是1
1. 这是二级的有序列表,阿拉伯数字在显示的时候变成了罗马数字
1. 这是三级的有序列表,数字在显示的时候变成了英文字母
效果
- 这是一级的有序列表,数字1还是1
- 这是二级的有序列表,阿拉伯数字在显示的时候变成了罗马数字
- 这是三级的有序列表,数字在显示的时候变成了英文字母
- 这是二级的有序列表,阿拉伯数字在显示的时候变成了罗马数字
复选框列表
语法
- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
- [ ] 编码
- [ ] 测试
- [ ] 交付
效果
- 需求分析
- 系统设计
- 详细设计
- 编码
- 测试
- 交付
您可以使用这个功能来标注某个项目各项任务的完成情况。
块引用
常用于引用文本
> **“端”(endian)的起源**
以下是Jonathan Swift在1726年关于大小端之争历史的描述:
“...下面我要告诉你的是...”
效果
“端”(endian)的起源 以下是Jonathan Swift在1726年关于大小端之争历史的描述: “…下面我要告诉你的是…”
块引用有多级结构
语法
> 数据结构
>> 树
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树
效果
数据结构
树
二叉树
平衡二叉树
满二叉树
代码高亮
语法
在三个反引号后面加上编程语言的名字,另起一行开始写代码,最后一行再加上三个反引号。
注意⚠️:在post中编程语言开头要小写如java
、python
、kotlin
,开头大写如Java
网站不会高亮。
效果
// Java
public static void main(String[]args){}
# Python
s = "Python syntax highlighting"
print s
// Kotlin
fun main(args : Array<String>) {
println("Hello, World!")
}
// Go
package main
import "fmt"
func main() {
fmt.Println("hello world")
}
# MySQL
CREATE TABLE cats
(
id INT unsigned NOT NULL AUTO_INCREMENT, # Unique ID for the record
name VARCHAR(150) NOT NULL, # Name of the cat
birth DATE NOT NULL, # Birthday of the cat
PRIMARY KEY (id) # Make the id the primary key
);
// C
int main(int argc, char *argv[])
# Bash
echo "hello GitHub"
// Javascipt
document.getElementById("myH1").innerHTML="Welcome to my Homepage";
// C++
string &operator+(const string& A,const string& B)
表格
表头1 | 表头2 |
---|---|
表格单元 | 表格单元 |
表格单元 | 表格单元 |
表头1 | 表头2 |
---|---|
表格单元 | 表格单元 |
表格单元 | 表格单元 |
对齐
表格可以指定对齐方式
左对齐 | 居中 | 右对齐 |
---|---|---|
col 3 is | some wordy text | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
混合其他语法
表格单元中的内容可以和其他大多数GFM语法配合使用,如:
使用普通文本的删除线,斜体等效果
名字 | 描述 |
---|---|
Help | |
Close | Closes a window |
折叠
语法
<details>
<summary>Linux环境</summary>
##### 编译
xxxx
##### 安装
xxxx
</details>
效果
Linux环境
编译
xxxx安装
xxxxYouTube视频
在_includes
文件夹中新建iframe_video.html
在YouTube视频中点击Share > Embed
语法
iframe_video.html
<iframe width="560" height="315" src="https://www.youtube.com/embed/wB3rlepYqMg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
效果
Google Drive PDF
参考本文
在_includes
文件夹中新建一个html文件,如iframe_pdf_example.html
在Google Drive文件的Preview
模式中点击Open in new window > Embed item
,复制到新建的html文件中
语法
iframe_pdf_example.html
<iframe src="https://drive.google.com/file/d/1NL0BE0FT3j6qtAn2PgFMzyh71ey34GWk/preview" width="640" height="480" allow="autoplay"></iframe>
效果
其他
还有一些非markdown语法,但是在README文件中也很实用的组件。
徽章
绘制徽章,首选就是shields.io 具体语法去官网探索。
其次有些第三方平台也提供方便的徽章,比如gitter。
star历史
star历史可以使用这个网站star-history.com。
🎉 Credit
GIFs from Giphy