github markdown語法及使用

歷史

Markdown是一種輕量級標記語言,創始人爲約翰·格魯伯(英語:John Gruber)。它容許人們「使用易讀易寫的純文本格式編寫文檔,而後轉換成有效的XHTML(或者HTML)文檔」,
自從GitHub流行以來,Markdown做爲一種輕量級標記語言就深受程序員的喜好,上手也是很是簡單,接下來咱們就來分析一下爲何markdown爲何能被一貫挑剔的程序員們愛不釋手呢?linux

語法

(注:Markdown發展至今衍生出一些細節上有些許差別的版本,這裏以GitHub 的Flavored Markdown(一樣在標準Markdown語法上有一些修改) 語法爲標準討論,誰叫咱是程序員呢..)
***git


Markdown支持多級標題對應不一樣的字體大小,例如:

# Markdown
## Markdown
### Markdown
#### Markdown
##### Markdown
###### Markdown

所對應的顯示內容爲:程序員

Markdown

Markdown

Markdown

Markdown

Markdown
Markdown

最多能夠支持6個,並且須要注意的是,這裏的#開頭的文字或標題必須另起一行,#和文字中間必須有空格,否則GitHub的README沒法識別。
同時,有些愛思考的同窗就會說,要是我用七個#,會不會將前六個#做爲字體符號,最後一個在文本中顯示呢。例如:github

####### Markdown

而結果是:markdown

Markdown測試

顯然,Markdown並無對其進行轉化。字體


除了用#標識字體(標題)大小,還有一種方法:

Markdown
=========
Markdown
---------

所對應的顯示內容爲:spa

Markdown

Markdown


這裏的字體只分爲兩級,大號的字體下一行用"="號隔開,略小一號的字體用"-"(短橫線)隔開,"="或"-"的數量最好是三個以上,可是有些版本能夠爲一個,一般的習慣爲與字體等長。code


二、段落和換行


分隔線

在實際的文本顯示中,爲了使文本更加清晰明瞭,能夠適當地加入一些分隔線對象

***
---

分隔線由或者---表示,通常是三個連續的符號,單行開頭,也能夠多於三個

換行

換行可使用一個或者多個空行來另起一個段落,注意是一個空行,而不是簡單地用回車來另換一行,示例:

第一行

第二行
第三行

所對應的顯示內容爲:

第一行
第二行第三行

很明顯,第二行和第三行連到了一塊兒,那若是我就是不喜歡隔一個空行,非要以回車來換行呢,考慮到部分強迫症晚期患者,Markdown有另外一種換行的方法:
在上一行的行尾添加兩個空格,而後以回車來換行,建議用空行換行
***

插入文本引用

若是我須要將一段文本與正文文本相區分,好比示例,引用文章之類的,怎麼作呢?

答案是先換行(隔一個或者多個空行),而後新行以tab鍵開頭,鍵入文本,示例:

正文

    引用文本示例

所對應的顯示內容爲:

正文

引用文本示例。

列表

無序列表

無序列表k而已使用* + -來標識,注意在字符以後要添加一個空格,示例:

* Markdown1
+ Markdown2
- Markdown3

所對應的顯示內容爲:

  • Markdown1
  • Markdown2
  • Markdown3

結果顯示,這三種符號是能夠交叉使用的


有序列表

有序列表須要添加一個相應的'數字'+'.'+'空格'來標識,示例:

1. Markdown1   
2. Markdown2  
3. Markdown3

所對應的顯示內容爲:

  1. Markdown1
  2. Markdown2
  3. Markdown3

代碼

如何把代碼貼上去呢?很簡單,將代碼用兩個`包含起來,這個符號不是單引號,而是反引號,鍵盤左上角那個

`print "hello world" `

所對應的顯示內容爲

print "hello world"

同時也能夠用上面提到的引用文本的方法來貼代碼


連接

添加連接的方法爲:

[博客](https://www.cnblogs.com/downey-blog/)

所對應的顯示內容爲:

博客

,點擊高亮字體便可進入相應連接


設置跳轉

在寫文檔時,常常會須要在某段文本上設置連接,跳轉到另外一段文本中,最多見的是註腳,對於這些註腳,並不方便寫在正文中,可是寫在文檔末尾又沒頭沒尾的,咱們就能夠設置一個鏈接跳轉。它的語法是這樣的:
在須要跳轉的文本處添加:

[跳轉到末尾](#jump1)

在跳轉目的地添加:

<span id="jump1">測試跳轉的文本</span>

所對應的效果爲:跳轉到末尾

注意[]中包含顯示的說明文本,而(#jump1)至關於定義一個匹配對象。

在跳轉目的地則是XXX的格式,jump1對應上述的匹配對象,而XXX是須要添加的文本。

插入圖片

插入圖片的方法與插入連接相比僅僅在前面多了一個 "!",即:

![pic](https://raw.githubusercontent.com/linux-downey/bloc_test/master/picture/Makedown/Makedown.png)

所對應的顯示內容爲:

pic

值得注意的是,目前還並無一種兼容性比較好的方法將圖片內嵌到文本中,通常的作法是在文本內引用圖片的連接,可是在這種作法下,若是圖片資源一旦遷移,將會額外增長修改爲本


修改圖片大小

若是要修改圖片大小,可使用HTML的處理方式來插入圖片,並設置固定大小

<img src="https://raw.githubusercontent.com/linux-downey/bloc_test/master/picture/Makedown/Makedown.png" width=100 height=60 />

所對應的顯示內容爲:

同時,也能夠按照比例來設置圖片大小

<img src="https://raw.githubusercontent.com/linux-downey/bloc_test/master/picture/Makedown/Makedown.png" width="%50" height="%50" />

所對應的顯示內容爲:


測試跳轉的文本


好了,關於markdown的基本語法和使用介紹就到此爲止啦,若是朋友們對於這個有什麼疑問或者發現有文章中有什麼錯誤,歡迎留言

原創博客,轉載請註明出處!

祝各位早日實現項目叢中過,bug不沾身. (完)

相關文章
相關標籤/搜索