用markdown語法寫GitHub上README文件

這篇文章是本人平時的一些筆記,可能會有很多人寫過相關的東西,而且更為全面。目的只是分享一些自己平時的東西,勿噴?。。。?/p>

README文件

README文件可能大家都不會陌生,在我們上傳一些自己的工程文件到GitHub時,附加的一個說明文檔,會顯示在倉庫的詳情中。使用markDown語法編寫可以讓其看起來更加清晰明朗一些。

具體的相關語法說明

readme文件的創建和編輯在這里就不多介紹了,相信使用過git的朋友們應該不會陌生。下面是一些常用的語法:

1.標題

首先是大標題,大標題是在作為標題的文字下面添加=號,個數不限;
其次是中標題,中標題在作為標題的文字下面添加-號,個數不限;
最后是各級小標題,分為六級,#號開頭 ,每多一級多一個#號,比如:一級標題是#,二級標題是##,以此類推下去。下面是相關的效果展示:

大標題

中標題

一級標題

二級標題

三級標題

四級標題

五級標題
六級標題

+++++++手動分割線+++++++++

2.文本

首先是普通文本,文本主要是換行符,"< br >"(去掉空格)或者是雙空格加回車,如下:
這是一條可以換行的話,
這里是使用換行符換行。
這里是使用雙空格加回車換行

然后是單行和多行文本, 使用兩個Tab符實現單行文本;多行文本和單行文本異曲同工,只要在每行行首加兩個Tab,比如
hello,swift
親愛的領導:
你好!
再見

最后是文本的格式化和插入:

字體高亮:

把需要設置的字體用包圍,是Tab上方,數字1左邊的按鍵。如下:
窗前明月光,疑是上霜

粗體和斜體:

用兩個 星號 包含一段文本就是粗體的語法,用一個星號包含一段文本就是斜體的語法。
頭望明月,低頭思故鄉

引用:

在引用的句子前面加上 > 號即可:

靜夜思
窗前明月光,
疑是地上霜。
舉頭望明月,
低頭思故鄉。

文本超鏈接:

格式是: [ 要顯示的文字 ]( 鏈接的地址 ** "懸浮顯示")** ,還可以給他加上一個鼠標懸停顯示的文本,就像css中的hover屬性。如下:
百度一下

列表:

無序列表的話,你只需要在文字前面加上 - + 空格 就可以了,有序列表的話就在前面加上1. 2. 3等;圓點符的話,加上*號。如果想要分級的話在每一級前面加個tab鍵即可, 如下:
無序列表:

  • 無序1
  • 無序2
  • 無序3

有序列表:

  1. 無序1
  2. 無序2
  3. 無序3

圓點符:

  • 文本
  • 文本
  • 文本

分級列表:

  • 文本
    • 文本
      • 文本
插入圖片,添加圖片鏈接

嘆號! + 方括號[ ] + 括號( ) 其中括號里是圖片的URL。在方括號里可以加入一些 標識性的信息


baidu
代碼引用

這個對開發者可能比較有用處:
需要引用代碼時,如果引用的語句只有一段,不分行,可以用 (tab鍵上面的,1鍵旁邊的鍵位)將語句包起來。如果引用的語句為多行,可以將三個(tab鍵上面的,1鍵旁邊的鍵位)置于這段代碼的首行和末行。
var name = "hello , wrold"

if let removedValue = airports.removeValueForKey("DUB"){
    print("The removed airport's name is (removedValue).")
} else {
    print("The airports dictionary does not contain a value for DUB.")
}// prints "The removed airport's name is Dublin Airport." 

結語:

簡書也自帶markdown功能,編輯起來很方便。上面只是一些簡單的操作,還有一些復雜的語法規則如果平時用到的話,可以自行在網上查詢。markdown對撰寫blog還是蠻實用和重要的?。。∠M軒偷酱蠹?。。加油?。?!

這里有一篇參考的博客和一個應用實例的鏈接:

獻給寫作者的 Markdown 新手指南
REDEME實例

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,247評論 6 543
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,520評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,362評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,805評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,541評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,896評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,887評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,062評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,608評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,356評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,555評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,077評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,769評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,175評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,489評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,289評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,516評論 2 379

推薦閱讀更多精彩內容