這篇文章是本人平時的一些筆記,可能會有很多人寫過相關的東西,而且更為全面。目的只是分享一些自己平時的東西,勿噴?。。。?/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
- 無序2
- 無序3
圓點符:
- 文本
- 文本
- 文本
分級列表:
- 文本
- 文本
- 文本
- 文本
插入圖片,添加圖片鏈接
嘆號! + 方括號[ ] + 括號( ) 其中括號里是圖片的URL。在方括號里可以加入一些 標識性的信息
代碼引用
這個對開發者可能比較有用處:
需要引用代碼時,如果引用的語句只有一段,不分行,可以用 (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軒偷酱蠹?。。加油?。?!