GitHub中的README.MD文件編寫語法

jopen 9年前發布 | 26K 次閱讀 Git 版本控制系統 Github

GitHub中的README文件,使用markdown格式的文件。這種文件語法比較簡單,特別容易上手。

Markdown的語法簡潔明了、學習容易,而且功能比純文本更強,因此有很多人用它寫博客。世界上最流行的博客平臺 WordPress 和大型CMS如 joomladrupal 都能很好的支持Markdown。

下面簡單介紹下相關語法:

大標題:

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

大標題一般顯示工程名,你只要在標題下面跟上=====即可(“=”個數無限制)

中標題

———————————-

中標題一般顯示重點項,你只要在標題下面輸入——即可(“-”個數無限制)

小標題:

小標題的格式如下 ### 小標題,注意#和標題字符中間要有空格

也可以使用1到6個“#”來表示六級標題:

# 這是 H1

## 這是 H2

###### 這是 H6

斜體:

可以使用*或_包圍文字,例如*Hello World*

加粗:

用兩個*或_包起來的話,達到加粗字體的左右,例如**Hello Markdown**

如果你的*和_兩邊都有空白的話,它們就只會被當成普通的符號

單行文本框:

只要兩個Tab再輸入文字即可

多行文本框:

你可以寫入代碼等,每行文字只要輸入兩個Tab再輸入文字即可

引用:

引用是使用類似 email 中用>的引用方式,例如:> 文字被些字符包圍開始,可以在每行上加上“<”,也可以只在首行加上“<”能夠達到一樣的效果。區塊引用可以嵌套(例如:引用內的引用),只要根據層次加上不同數量的>:

&gt; 這是第一層引用。

&gt;

&gt; &gt; 這是嵌套的引用塊。

&gt;

&gt; 回到第一層。

列表:

無序列表使用星號、加號或是減號作為列表標記,例如:*Red、+Green、-Blue

有序列表則使用數字接著一個英文句點,例如:1.hello;注意,你在列表標記上使用的數字并不會影響輸出的 HTML 結果,你可以使用1. Bird 1. McHale 1. Parish甚至6.ADC 3.EFG 9.XYZ 都可以實現正確的有序列表顯示。

超鏈接:

Markdown 支持兩種形式的鏈接語法: 行內式和參考式兩種形式。

不管是哪一種,鏈接文字都是用 [方括號] 來標記;要建立一個 行內式 的鏈接,只要在方塊括號后面緊接著圓括號并插入網址鏈接即可,如果你還想要加上鏈接的 title 文字,只要在網址后面,用雙引號把 title 文字包起來即可,例如:[This link](http://example.net/) has no title attribute

如果你是要鏈接到同樣主機的資源,你可以使用相對路徑:See my [About](/about/) page for details

參考式的鏈接是在鏈接文字的括號后面再接上另一個方括號,而在第二個方括號里面要填入用以辨識鏈接的標記:This is [an example][id] reference-style link

接著,在文件的任意處,你可以把這個標記的鏈接內容定義出來:[id]: http://example.com/ "Optional Title Here"

圖片:

圖片的語法和超鏈接非常相似。只顯示圖片:![github](http://example.com/unicorn.png “github”);點擊圖片進入另一個網頁:[![image]](http://www.example.com/) [image]: http://example.com/example.png “example“

 本文由用戶 jopen 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!