2最近對它的README.md文件頗為感興趣劫拢。便寫下這簡書,希望幫助更多的還不會編寫README文件的同學(xué)們妹沙。
README文件后綴名為md熟吏。md是markdown的縮寫,markdown是一種編輯博客的語言牵寺。
Markdown 語法簡單用法
- 標(biāo)題
大標(biāo)題
=======
小標(biāo)題
- ' #'+漢字組成各級標(biāo)題,中間要空格
一級標(biāo)題
二級標(biāo)題
三級標(biāo)題
四級標(biāo)題
五級標(biāo)題
六級標(biāo)題
eg:
#一級標(biāo)題
##二級標(biāo)題
###三級標(biāo)題
####四級標(biāo)題
#####五級標(biāo)題
######六級標(biāo)題
注釋:大標(biāo)題和小標(biāo)題分別對應(yīng)一趣斤、二級標(biāo)題
3.下分割線
文字
“-------”
4 . 文字超鏈接 百度
文字(URL)
5 . 插入符號
一. 圓點符
- 昵稱:果凍蝦仁
- 別名:隔壁老王
- 英文名:Jelly
eg:
* 昵稱:果凍蝦仁
* 別名:隔壁老王
* 英文名:Jelly
二. 二級圓點 三級圓點前多加tab
- 昵稱:果凍蝦仁
- 別名:隔壁老王
- 英文名:Jelly
- 別名:隔壁老王
eg:
* 昵稱:果凍蝦仁
* 別名:隔壁老王
* 英文名:Jelly
6 .縮進(jìn)
地球
亞洲
中國
深圳
eg:
>地球
>>亞洲
>>>中國
>>>>深圳
7 . 圖片+文字說明(gif和普通圖片相同)
小黃雞
eg:


8 . 代碼引用
中國人
self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];
eg:
`中國人 `
`self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];`
9 . 文字引用
一盞燈浓领, 一片昏黃奋渔; 一簡書, 一杯淡茶撑蒜。 守著那一份淡定玄渗, 品讀屬于自己的寂寞。 保持淡定藤树, 才能欣賞到最美麗的風(fēng)景! 保持淡定岁钓, 人生從此不再寂寞微王。
eg:文字前加>
一盞燈品嚣, 一片昏黃; 一簡書罩旋, 一杯淡茶眶诈。 守著那一份淡定, 品讀屬于自己的寂寞逝撬。 保持淡定, 才能欣賞到最美麗的風(fēng)景靠闭! 保持淡定坎炼, 人生從此不再寂寞。
10 . 表格
星期 | 車次 | 時間 |
---|---|---|
星期一 | G1008 | 4:30 |
星期二 | G1006 | 14:55 |
星期三 | G1007 | 18:30 |
星期四 | G1009 | 21:30 |
eg: “---------”左右兩邊的“:”決定文字的對齊方式
| 星期 | 車次 | 時間 |
| ------------- |:-------------:| -----:|
| 星期一 |G1008 | 4:30 |
| 星期二 | G1006 | 14:55 |
| 星期三 | G1007 | 18:30 |