readme 語法

README

===========================

該文件用來測試和展現書寫README的各類markdown語法。GitHub的markdown語法在標準的markdown語法基礎上作了擴充，稱之爲`GitHub Flavored Markdown`。簡稱`GFM`，GFM在GitHub上有普遍應用，除了README文件外，issues和wiki均支持markdown語法。

 

****

 

|Author|果凍蝦仁|

|---|---

|E-mail|Jelly.K.Wang@qq.com

 

 

****

## 目錄

* [橫線](#橫線)

* [標題](#標題)

* [文本](#文本)

    * 普通文本

    * 單行文本

    * 多行文本

    * 文字高亮

    * 換行

    * 斜體

    * 粗體

    * 刪除線

* [圖片](#圖片)

    * 來源於網絡的圖片

    * GitHub倉庫中的圖片

* [連接](#連接) 

    * 文字超連接

        * 連接外部URL

        * 連接本倉庫裏的URL

    * 錨點

    * [圖片連接](#圖片連接)

* [列表](#列表)

    * 無序列表

    * 有序列表

    * 複選框列表

* [塊引用](#塊引用)

* [代碼高亮](#代碼高亮)

* [表格](#表格) 

* [表情](#表情)

* [diff語法](#diff語法)

 

### 橫線

-----------

***、---、___能夠顯示橫線效果

 

***

---

___

 

 

 

標題

------

 

# 一級標題  

## 二級標題  

### 三級標題  

#### 四級標題  

##### 五級標題  

###### 六級標題  

 

 

文本

------

### 普通文本

這是一段普通的文本

### 單行文本

    Hello,你們好，我是果凍蝦仁。

在一行開頭加入1個Tab或者4個空格。

### 文本塊

#### 語法1

在連續幾行的文本開頭加入1個Tab或者4個空格。

 

    歡迎到訪

    很高興見到您

    祝您，早上好，中午好，下午好，晚安

 

#### 語法2

使用一對各三個的反引號：

```

歡迎到訪

我是C++碼農

你能夠在知乎、CSDN、簡書搜索【果凍蝦仁】找到我

```

該語法也能夠實現代碼高亮，見[代碼高亮](#代碼高亮)

### 文字高亮

文字高亮功能能使行內部分文字高亮，使用一對反引號。

語法：

```

`linux` `網絡編程` `socket` `epoll` 

```

效果：`linux` `網絡編程` `socket` `epoll`

 

也適合作一篇文章的tag

#### 換行

直接回車不能換行，  

能夠在上一行文本後面補兩個空格，  

這樣下一行的文本就換行了。

 

或者就是在兩行文本直接加一個空行。

 

也能實現換行效果，不過這個行間距有點大。

#### 斜體、粗體、刪除線

 

|語法|效果|

|----|-----|

|`*斜體1*`|*斜體1*|

|`_斜體2_`| _斜體2_|

|`**粗體1**`|**粗體1**|

|`__粗體2__`|__粗體2__|

|`這是一個 ~~刪除線~~`|這是一個 ~~刪除線~~|

|`***斜粗體1***`|***斜粗體1***|

|`___斜粗體2___`|___斜粗體2___|

|`***~~斜粗體刪除線1~~***`|***~~斜粗體刪除線1~~***|

|`~~***斜粗體刪除線2***~~`|~~***斜粗體刪除線2***~~|

 

    斜體、粗體、刪除線可混合使用

 

圖片

------

基本格式：

```


```

alt和title即對應HTML中的alt和title屬性（均可省略）：

- alt表示圖片顯示失敗時的替換文本

- title表示鼠標懸停在圖片時的顯示文本（注意這裏要加引號）

 

URL即圖片的url地址，若是引用本倉庫中的圖片，直接使用**相對路徑**就可了，若是引用其餘github倉庫中的圖片要注意格式，即：`倉庫地址/raw/分支名/圖片路徑`，如：

```

https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif

```

 

|#|語法|效果|

|---|---|----

|1|``|

|2|`![][foryou]`|![][foryou]

 

注意例2的寫法使用了**URL標識符**的形式，在[連接](#連接)一節有介紹。

>在文末有foryou的定義：

```

[foryou]:https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif

```

 

連接

------

### 連接外部URL

 

|#|語法|效果|

|---|----|-----|

|1|`[個人博客](http://blog.csdn.net/guodongxiaren "懸停顯示")`|[個人博客](http://blog.csdn.net/guodongxiaren "懸停顯示")|

|2|`[個人知乎][zhihu] `|[個人知乎][zhihu] |

 

語法2由兩部分組成：

- 第一部分使用兩個中括號，[ ]裏的標識符（本例中zhihu），能夠是數字，字母等的組合，標識符上下對應就好了（**姑且稱之爲URL標識符**）

- 第二部分標記實際URL。

 

>使用URL標識符能達到複用的目的，通常把全文全部的URL標識符統一放在文章末尾，這樣看起來比較乾淨。

>>URL標識符是我起的名字，不知道是否準確。囧。。

 

### 連接本倉庫裏的URL

 

|語法|效果|

|----|-----|

|`[個人簡介](/example/profile.md)`|[個人簡介](/example/profile.md)|

|`[Book](./Book)`|[Book](/Book)|

 

### 圖片連接

給圖片加連接的本質是混合圖片顯示語法和普通的連接語法。普通的連接中[ ]內部是連接要顯示的文本，而圖片連接[ ]裏面則是要顯示的圖片。  

直接混合兩種語法固然能夠，可是十分囉嗦，爲此咱們可使用URL標識符的形式。

 

|#|語法|效果|

|---|----|:---:|

|1|`[![weibo-logo]](http://weibo.com/linpiaochen)`|[![weibo-logo]](http://weibo.com/linpiaochen)|

|2|`[][zhihu]`|[][zhihu]|

|3|`[![csdn-logo]][csdn]`|[![csdn-logo]][csdn]|

 

由於圖片自己和連接自己都支持URL標識符的形式，因此圖片連接也能夠很簡潔（見例3）。  

注意，此時鼠標懸停時顯示的文字是圖片的title，而非連接自己的title了。

> 本文URL標識符都放置於文末

 

### 錨點

其實呢，每個標題都是一個錨點，和HTML的錨點（`#`）相似，好比咱們 

 

|語法|效果|

|---|---|

|`[回到頂部](#readme)`|[回到頂部](#readme)|

 

不過要注意，標題中的英文字母都被轉化爲**小寫字母**了。

> 之前GitHub對中文支持的很差，因此中文標題不能正確識別爲錨點，可是如今已經沒問題啦！

 

## 列表

### 無序列表

* 暱稱：果凍蝦仁

- 別名：隔壁老王

* 英文名：Jelly

 

### 多級無序列表

* 編程語言

    * 腳本語言

        * Python

 

### 有序列表

#### 通常效果

就是在數字後面加一個點，再加一個空格。不過看起來起來可能不夠明顯。    

面向對象的三個基本特徵：

 

1. 封裝

2. 繼承

3. 多態

 

 

#### 多級有序列表

和無序列表同樣，有序列表也有多級結構：  

 

1. 這是一級的有序列表，數字1仍是1

   1. 這是二級的有序列表，阿拉伯數字在顯示的時候變成了羅馬數字

      1. 這是三級的有序列表，數字在顯示的時候變成了英文字母

  

 

### 複選框列表

- [x] 需求分析

- [x] 系統設計

- [x] 詳細設計

- [ ] 編碼

- [ ] 測試

- [ ] 交付

 

您可使用這個功能來標註某個項目各項任務的完成狀況。

> Tip:

>> 在GitHub的**issue**中使用該語法是能夠實時點擊複選框來勾選或解除勾選的，而無需修改issue原文。

 

## 塊引用

 

### 經常使用於引用文本

#### 文本摘自《深刻理解計算機系統》P27

　使人吃驚的是，在哪一種字節順序是合適的這個問題上，人們表現得很是情緒化。實際上術語「little endian」（小端）和「big endian」（大端）出自Jonathan Swift的《格利佛遊記》一書，其中交戰的兩個派別沒法就應該從哪一端打開一個半熟的雞蛋達成一致。所以，爭論淪爲關於社會政治的爭論。只要選擇了一種規則而且始終如一的堅持，其實對於哪一種字節排序的選擇都是任意的。

> **「端」（endian）的起源**  

如下是Jonathan Swift在1726年關於大小端之爭歷史的描述：  

「……下面我要告訴你的是，Lilliput和Blefuscu這兩大強國在過去36個月裏一直在苦戰。戰爭開始是因爲如下的緣由：咱們你們都認爲，吃雞蛋前，原始的方法是打破雞蛋較大的一端，但是當今的皇帝的祖父小時候吃雞蛋，一次按古法打雞蛋時碰巧將一個手指弄破了，所以他的父親，當時的皇帝，就下了一道敕令，命令全體臣民吃雞蛋時打破較小的一端，違令者重罰。」

 

### 塊引用有多級結構

> 數據結構

>> 樹

>>> 二叉樹

>>>> 平衡二叉樹

>>>>> 滿二叉樹

 

代碼高亮

----------

在三個反引號後面加上編程語言的名字，另起一行開始寫代碼，最後一行再加上三個反引號。

```Java

public static void main(String[]args){} //Java

```

```c

int main(int argc, char *argv[]) //C

```

```Bash

echo "hello GitHub" #Bash

```

```javascript

document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javascipt

```

```cpp

string &operator+(const string& A,const string& B) //cpp

```

表格

--------

 

表頭1 | 表頭2|

--------- | --------|

表格單元 | 表格單元 |

表格單元 | 表格單元 |

 

| 表頭1 | 表頭2|

| ---------- | -----------|

| 表格單元 | 表格單元 |

| 表格單元 | 表格單元 |

 

### 對齊

表格能夠指定對齊方式

 

| 左對齊 | 居中 | 右對齊 |

| :------------ |:---------------:| -----:|

| 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 |

 

#### 表格中嵌入圖片（連接）

其實前面介紹圖片顯示、圖片連接的時候爲了清晰就是放在在表格中顯示的。

 

| 圖片 | 描述 |

| ---- | ---- |

|![baidu][baidu-logo] | 百度|

 

表情

----------

Github的Markdown語法支持添加emoji表情，輸入不一樣的符號碼（兩個冒號包圍的字符）能夠顯示出不一樣的表情。

 

好比`:blush:`，能夠顯示:blush:。

 

具體每個表情的符號碼，能夠查詢GitHub的官方網頁[http://www.emoji-cheat-sheet.com](http://www.emoji-cheat-sheet.com)。

 

可是這個網頁每次都打開**奇慢**。。因此我整理到了本repo中，你們能夠直接在此查看[emoji](./emoji.md)。

 

diff語法

---------

版本控制的系統中都少不了diff的功能，即展現一個文件內容的增長與刪除。

GFM中能夠顯示的展現diff效果。使用綠色表示新增，紅色表示刪除。

 

其語法與代碼高亮相似，只是在三個反引號後面寫diff，

而且其內容中，以 `+ `開頭表示新增，`- `開頭表示刪除。

 

效果以下：

 

```diff

+ 鳥宿池邊樹，僧敲月下門

- 鳥宿池邊樹，僧推月下門

```