README
該文件用來測試和展示書寫README的各種markdown語法。GitHub的markdown語法在標(biāo)準(zhǔn)的markdown語法基礎(chǔ)上做了擴(kuò)充,稱之為GitHub Flavored Markdown。簡稱GFM,GFM在GitHub上有廣泛應(yīng)用,除了README文件外,issues和wiki均支持markdown語法。
| Author | 果凍蝦仁 |
|---|---|
| Jelly.K.Wang@qq.com |
目錄
- 橫線
- 標(biāo)題
-
文本
- 普通文本
- 單行文本
- 多行文本
- 文字高亮
- 換行
- 斜體
- 粗體
- 刪除線
-
圖片
- 來源于網(wǎng)絡(luò)的圖片
- GitHub倉庫中的圖片
-
鏈接
- 文字超鏈接
- 鏈接外部URL
- 鏈接本倉庫里的URL
- 錨點(diǎn)
- 圖片鏈接
- 文字超鏈接
-
列表
- 無序列表
- 有序列表
- 復(fù)選框列表
- 塊引用
- 代碼高亮
- 表格
- 表情
- diff語法
橫線
***、---、___可以顯示橫線效果
標(biāo)題
一級(jí)標(biāo)題
二級(jí)標(biāo)題
三級(jí)標(biāo)題
四級(jí)標(biāo)題
五級(jí)標(biāo)題
六級(jí)標(biāo)題
文本
普通文本
這是一段普通的文本
單行文本
Hello,大家好,我是果凍蝦仁。
在一行開頭加入1個(gè)Tab或者4個(gè)空格。
文本塊
語法1
在連續(xù)幾行的文本開頭加入1個(gè)Tab或者4個(gè)空格。
歡迎到訪
很高興見到您
祝您,早上好,中午好,下午好,晚安
語法2
使用一對(duì)各三個(gè)的反引號(hào):
歡迎到訪
我是C++碼農(nóng)
你可以在知乎、CSDN、簡書搜索【果凍蝦仁】找到我
該語法也可以實(shí)現(xiàn)代碼高亮,見代碼高亮
文字高亮
文字高亮功能能使行內(nèi)部分文字高亮,使用一對(duì)反引號(hào)。
語法:
`linux` `網(wǎng)絡(luò)編程` `socket` `epoll`
效果:linux 網(wǎng)絡(luò)編程 socket epoll
也適合做一篇文章的tag
換行
直接回車不能換行,
可以在上一行文本后面補(bǔ)兩個(gè)空格,
這樣下一行的文本就換行了。
或者就是在兩行文本直接加一個(gè)空行。
也能實(shí)現(xiàn)換行效果,不過這個(gè)行間距有點(diǎn)大。
斜體、粗體、刪除線
| 語法 | 效果 |
|---|---|
*斜體1* |
斜體1 |
_斜體2_ |
斜體2 |
**粗體1** |
粗體1 |
__粗體2__ |
粗體2 |
這是一個(gè) ~~刪除線~~ |
這是一個(gè) |
***斜粗體1*** |
斜粗體1 |
___斜粗體2___ |
斜粗體2 |
***~~斜粗體刪除線1~~*** |
|
~~***斜粗體刪除線2***~~ |
斜體、粗體、刪除線可混合使用
圖片
基本格式:

alt和title即對(duì)應(yīng)HTML中的alt和title屬性(都可省略):
- alt表示圖片顯示失敗時(shí)的替換文本
- title表示鼠標(biāo)懸停在圖片時(shí)的顯示文本(注意這里要加引號(hào))
URL即圖片的url地址,如果引用本倉庫中的圖片,直接使用相對(duì)路徑就可了,如果引用其他github倉庫中的圖片要注意格式,即:倉庫地址/raw/分支名/圖片路徑,如:
https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
| # | 語法 | 效果 |
|---|---|---|
| 1 |  |
![]() baidu
|
| 2 | ![][foryou] |
注意例2的寫法使用了URL標(biāo)識(shí)符的形式,在鏈接一節(jié)有介紹。
在文末有foryou的定義:
[foryou]:https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
鏈接
鏈接外部URL
| # | 語法 | 效果 |
|---|---|---|
| 1 | [我的博客](http://blog.csdn.net/guodongxiaren "懸停顯示") |
我的博客 |
| 2 | [我的知乎][zhihu] |
我的知乎 |
語法2由兩部分組成:
- 第一部分使用兩個(gè)中括號(hào),[ ]里的標(biāo)識(shí)符(本例中zhihu),可以是數(shù)字,字母等的組合,標(biāo)識(shí)符上下對(duì)應(yīng)就行了(姑且稱之為URL標(biāo)識(shí)符)
- 第二部分標(biāo)記實(shí)際URL。
使用URL標(biāo)識(shí)符能達(dá)到復(fù)用的目的,一般把全文所有的URL標(biāo)識(shí)符統(tǒng)一放在文章末尾,這樣看起來比較干凈。
URL標(biāo)識(shí)符是我起的名字,不知道是否準(zhǔn)確。囧。。
鏈接本倉庫里的URL
| 語法 | 效果 |
|---|---|
[我的簡介](/example/profile.md) |
我的簡介 |
[Book](./Book) |
Book |
圖片鏈接
給圖片加鏈接的本質(zhì)是混合圖片顯示語法和普通的鏈接語法。普通的鏈接中[ ]內(nèi)部是鏈接要顯示的文本,而圖片鏈接[ ]里面則是要顯示的圖片。
直接混合兩種語法當(dāng)然可以,但是十分啰嗦,為此我們可以使用URL標(biāo)識(shí)符的形式。
| # | 語法 | 效果 |
|---|---|---|
| 1 | [[圖片上傳失敗...(image-6a796f-1624609103438)] |
[[圖片上傳失敗...(image-1db435-1624609103438)] |
| 2 | [[圖片上傳失敗...(image-624b26-1624609103438)]][zhihu] |
[圖片上傳失敗...(image-48c012-1624609103438)] |
| 3 | [![csdn-logo]][csdn] |
![csdn-logo] |
因?yàn)閳D片本身和鏈接本身都支持URL標(biāo)識(shí)符的形式,所以圖片鏈接也可以很簡潔(見例3)。
注意,此時(shí)鼠標(biāo)懸停時(shí)顯示的文字是圖片的title,而非鏈接本身的title了。
本文URL標(biāo)識(shí)符都放置于文末
錨點(diǎn)
其實(shí)呢,每一個(gè)標(biāo)題都是一個(gè)錨點(diǎn),和HTML的錨點(diǎn)(#)類似,比如我們
| 語法 | 效果 |
|---|---|
[回到頂部](#readme) |
回到頂部 |
不過要注意,標(biāo)題中的英文字母都被轉(zhuǎn)化為小寫字母了。
以前GitHub對(duì)中文支持的不好,所以中文標(biāo)題不能正確識(shí)別為錨點(diǎn),但是現(xiàn)在已經(jīng)沒問題啦!
列表
無序列表
- 昵稱:果凍蝦仁
- 別名:隔壁老王
- 英文名:Jelly
多級(jí)無序列表
- 編程語言
- 腳本語言
- Python
- 腳本語言
有序列表
一般效果
就是在數(shù)字后面加一個(gè)點(diǎn),再加一個(gè)空格。不過看起來起來可能不夠明顯。
面向?qū)ο蟮娜齻€(gè)基本特征:
- 封裝
- 繼承
- 多態(tài)
多級(jí)有序列表
和無序列表一樣,有序列表也有多級(jí)結(jié)構(gòu):
- 這是一級(jí)的有序列表,數(shù)字1還是1
- 這是二級(jí)的有序列表,阿拉伯?dāng)?shù)字在顯示的時(shí)候變成了羅馬數(shù)字
- 這是三級(jí)的有序列表,數(shù)字在顯示的時(shí)候變成了英文字母
- 這是二級(jí)的有序列表,阿拉伯?dāng)?shù)字在顯示的時(shí)候變成了羅馬數(shù)字
復(fù)選框列表
- 需求分析
- 系統(tǒng)設(shè)計(jì)
- 詳細(xì)設(shè)計(jì)
- 編碼
- 測試
- 交付
您可以使用這個(gè)功能來標(biāo)注某個(gè)項(xiàng)目各項(xiàng)任務(wù)的完成情況。
Tip:
在GitHub的issue中使用該語法是可以實(shí)時(shí)點(diǎn)擊復(fù)選框來勾選或解除勾選的,而無需修改issue原文。
塊引用
常用于引用文本
文本摘自《深入理解計(jì)算機(jī)系統(tǒng)》P27
令人吃驚的是,在哪種字節(jié)順序是合適的這個(gè)問題上,人們表現(xiàn)得非常情緒化。實(shí)際上術(shù)語“l(fā)ittle endian”(小端)和“big endian”(大端)出自Jonathan Swift的《格利佛游記》一書,其中交戰(zhàn)的兩個(gè)派別無法就應(yīng)該從哪一端打開一個(gè)半熟的雞蛋達(dá)成一致。因此,爭論淪為關(guān)于社會(huì)政治的爭論。只要選擇了一種規(guī)則并且始終如一的堅(jiān)持,其實(shí)對(duì)于哪種字節(jié)排序的選擇都是任意的。
“端”(endian)的起源
以下是Jonathan Swift在1726年關(guān)于大小端之爭歷史的描述:
“……下面我要告訴你的是,Lilliput和Blefuscu這兩大強(qiáng)國在過去36個(gè)月里一直在苦戰(zhàn)。戰(zhàn)爭開始是由于以下的原因:我們大家都認(rèn)為,吃雞蛋前,原始的方法是打破雞蛋較大的一端,可是當(dāng)今的皇帝的祖父小時(shí)候吃雞蛋,一次按古法打雞蛋時(shí)碰巧將一個(gè)手指弄破了,因此他的父親,當(dāng)時(shí)的皇帝,就下了一道敕令,命令全體臣民吃雞蛋時(shí)打破較小的一端,違令者重罰?!?/p>
塊引用有多級(jí)結(jié)構(gòu)
數(shù)據(jù)結(jié)構(gòu)
樹
二叉樹
平衡二叉樹
滿二叉樹
代碼高亮
在三個(gè)反引號(hào)后面加上編程語言的名字,另起一行開始寫代碼,最后一行再加上三個(gè)反引號(hào)。
public static void main(String[]args){} //Java
int main(int argc, char *argv[]) //C
echo "hello GitHub" #Bash
document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javascipt
string &operator+(const string& A,const string& B) //cpp
表格
| 表頭1 | 表頭2 |
|---|---|
| 表格單元 | 表格單元 |
| 表格單元 | 表格單元 |
| 表頭1 | 表頭2 |
|---|---|
| 表格單元 | 表格單元 |
| 表格單元 | 表格單元 |
對(duì)齊
表格可以指定對(duì)齊方式
| 左對(duì)齊 | 居中 | 右對(duì)齊 |
|---|---|---|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
混合其他語法
表格單元中的內(nèi)容可以和其他大多數(shù)GFM語法配合使用,如:
使用普通文本的刪除線,斜體等效果
| 名字 | 描述 |
|---|---|
| Help |
|
| Close | Closes a window |
表格中嵌入圖片(鏈接)
其實(shí)前面介紹圖片顯示、圖片鏈接的時(shí)候?yàn)榱饲逦褪欠旁谠诒砀裰酗@示的。
| 圖片 | 描述 |
|---|---|
| 百度 |
表情
Github的Markdown語法支持添加emoji表情,輸入不同的符號(hào)碼(兩個(gè)冒號(hào)包圍的字符)可以顯示出不同的表情。
比如:blush:,可以顯示:blush:。
具體每一個(gè)表情的符號(hào)碼,可以查詢GitHub的官方網(wǎng)頁http://www.emoji-cheat-sheet.com。
但是這個(gè)網(wǎng)頁每次都打開奇慢。。所以我整理到了本repo中,大家可以直接在此查看emoji。
diff語法
版本控制的系統(tǒng)中都少不了diff的功能,即展示一個(gè)文件內(nèi)容的增加與刪除。
GFM中可以顯示的展示diff效果。使用綠色表示新增,紅色表示刪除。
其語法與代碼高亮類似,只是在三個(gè)反引號(hào)后面寫diff,
并且其內(nèi)容中,以 +開頭表示新增,-開頭表示刪除。
效果如下:
+ 鳥宿池邊樹,僧敲月下門
- 鳥宿池邊樹,僧推月下門
