GitHub上README.md簡(jiǎn)單教程

最近對(duì)它的README.md文件頗為感興趣。便寫(xiě)下這簡(jiǎn)書(shū)，希望幫助更多的還不會(huì)編寫(xiě)README文件的同學(xué)們。
README文件后綴名為md。md是markdown的縮寫(xiě)，markdown是一種編輯博客的語(yǔ)言。

Markdown 語(yǔ)法簡(jiǎn)單用法

  1. 標(biāo)題
大標(biāo)題  
=======

小標(biāo)題

  1. ' #'+漢字組成各級(jí)標(biāo)題，中間要空格

一級(jí)標(biāo)題

二級(jí)標(biāo)題

三級(jí)標(biāo)題

四級(jí)標(biāo)題

五級(jí)標(biāo)題
六級(jí)標(biāo)題
eg:
#一級(jí)標(biāo)題  
##二級(jí)標(biāo)題  
###三級(jí)標(biāo)題  
####四級(jí)標(biāo)題  
#####五級(jí)標(biāo)題  
######六級(jí)標(biāo)題

注釋：大標(biāo)題和小標(biāo)題分別對(duì)應(yīng)一、二級(jí)標(biāo)題

3.下分割線

文字
“-------”

4 . 超鏈接

示例：
- [Markdown](http://www.itdecent.cn/p/9349ebcb14a6)

5 . 插入符號(hào)
一. 圓點(diǎn)符

  • 昵稱：果凍蝦仁
  • 別名：隔壁老王
  • 英文名：Jelly
eg:
* 昵稱：果凍蝦仁  
* 別名：隔壁老王  
* 英文名：Jelly

二. 二級(jí)圓點(diǎn) 三級(jí)圓點(diǎn)前多加tab

  • 昵稱：果凍蝦仁
    • 別名：隔壁老王
      • 英文名：Jelly
eg:
* 昵稱：果凍蝦仁  
  * 別名：隔壁老王  
    * 英文名：Jelly

6 .縮進(jìn)

地球??

亞洲??

中國(guó) ????

深圳

eg:
>地球??
>>亞洲??
>>>中國(guó)  ????
>>>>深圳

7 . 圖片+文字說(shuō)明（gif和普通圖片相同）

![圖片alt](圖片地址 ''圖片title'')

圖片alt就是顯示在圖片下面的文字，相當(dāng)于對(duì)圖片內(nèi)容的解釋。
圖片title是圖片的標(biāo)題，當(dāng)鼠標(biāo)移到圖片上時(shí)顯示的內(nèi)容。title可加可不加
小黃雞

[圖片上傳失敗...(image-dfbb00-1564209815628)]

eg:
![小黃雞](http://upload-images.jianshu.io/upload_images/4673907-2074192aa737527d.gif?imageMogr2/auto-orient/strip)

![美景](http://img2.imgtn.bdimg.com/it/u=708621475,197951563&fm=23&gp=0.jpg)

8 . 代碼引用
中國(guó)人
self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];

eg:
`中國(guó)人 `
`self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];`

9 . 文字引用

一盞燈， 一片昏黃； 一簡(jiǎn)書(shū)， 一杯淡茶。 守著那一份淡定， 品讀屬于自己的寂寞。 保持淡定， 才能欣賞到最美麗的風(fēng)景！ 保持淡定， 人生從此不再寂寞。

eg:文字前加>
一盞燈， 一片昏黃； 一簡(jiǎn)書(shū)， 一杯淡茶。 守著那一份淡定， 品讀屬于自己的寂寞。 保持淡定， 才能欣賞到最美麗的風(fēng)景！ 保持淡定， 人生從此不再寂寞。

10 . 表格

星期 車(chē)次 時(shí)間
星期一 G1008 4:30
星期二 G1006 14:55
星期三 G1007 18:30
星期四 G1009 21:30 
eg:  “---------”左右兩邊的“：”決定文字的對(duì)齊方式
| 星期        | 車(chē)次           | 時(shí)間  |
| ------------- |:-------------:| -----:|
| 星期一      |G1008 | 4:30 |
|  星期二  | G1006      |  14:55 |
|  星期三   | G1007    |   18:30 |

Markdown 語(yǔ)法和 MWeb 寫(xiě)作使用說(shuō)明

效果如下：

[TOC]

Markdown 的設(shè)計(jì)哲學(xué)

Markdown 的目標(biāo)是實(shí)現(xiàn)「易讀易寫(xiě)」。
不過(guò)最需要強(qiáng)調(diào)的便是它的可讀性。一份使用 Markdown 格式撰寫(xiě)的文件應(yīng)該可以直接以純文字發(fā)佈，並且看起來(lái)不會(huì)像是由許多標(biāo)籤或是格式指令所構(gòu)成。
Markdown 的語(yǔ)法有個(gè)主要的目的：用來(lái)作為一種網(wǎng)路內(nèi)容的寫(xiě)作用語(yǔ)言。

本文約定

如果有寫(xiě) 效果如下：， 在 MWeb 編輯狀態(tài)下只有用 CMD + 4 或 CMD + R 預(yù)覽才可以看效果。

標(biāo)題

Markdown 語(yǔ)法：

# 第一級(jí)標(biāo)題 `<h1>` 
## 第二級(jí)標(biāo)題 `<h2>` 
###### 第六級(jí)標(biāo)題 `<h6>`

效果如下：

第一級(jí)標(biāo)題 <h1>

第二級(jí)標(biāo)題 <h2>

第六級(jí)標(biāo)題 <h6>

強(qiáng)調(diào)

Markdown 語(yǔ)法：

*這些文字會(huì)生成`<em>`*
_這些文字會(huì)生成`<u>`_

**這些文字會(huì)生成`<strong>`**
__這些文字會(huì)生成`<strong>`__

在 MWeb 中的快捷鍵為： CMD + U、CMD + I、CMD + B
效果如下：

這些文字會(huì)生成<em>
這些文字會(huì)生成<u>

這些文字會(huì)生成<strong>
這些文字會(huì)生成<strong>

換行

四個(gè)及以上空格加回車(chē)。
如果不想打這么多空格，只要回車(chē)就為換行，請(qǐng)勾選：Preferences - Themes - Translate newlines to <br> tags

列表

無(wú)序列表

Markdown 語(yǔ)法：

* 項(xiàng)目一 無(wú)序列表 `* + 空格鍵`
* 項(xiàng)目二
* 項(xiàng)目二的子項(xiàng)目一 無(wú)序列表 `TAB + * + 空格鍵`
* 項(xiàng)目二的子項(xiàng)目二

在 MWeb 中的快捷鍵為： Option + U
效果如下：

  • 項(xiàng)目一 無(wú)序列表 * + 空格鍵
  • 項(xiàng)目二
  • 項(xiàng)目二的子項(xiàng)目一 無(wú)序列表 TAB + * + 空格鍵
  • 項(xiàng)目二的子項(xiàng)目二

有序列表

Markdown 語(yǔ)法：

1. 項(xiàng)目一 有序列表 `數(shù)字 + . + 空格鍵`
2. 項(xiàng)目二 
3. 項(xiàng)目三
1. 項(xiàng)目三的子項(xiàng)目一 有序列表 `TAB + 數(shù)字 + . + 空格鍵`
2. 項(xiàng)目三的子項(xiàng)目二

效果如下：

  1. 項(xiàng)目一 有序列表 數(shù)字 + . + 空格鍵
  2. 項(xiàng)目二
  3. 項(xiàng)目三
  4. 項(xiàng)目三的子項(xiàng)目一 有序列表 TAB + 數(shù)字 + . + 空格鍵
  5. 項(xiàng)目三的子項(xiàng)目二

任務(wù)列表（Task lists）

Markdown 語(yǔ)法：

- [ ] 任務(wù)一 未做任務(wù) `- + 空格 + [ ]`
- [x] 任務(wù)二 已做任務(wù) `- + 空格 + [x]`

效果如下：

  • [ ] 任務(wù)一 未做任務(wù) - + 空格 + [ ]
  • [x] 任務(wù)二 已做任務(wù) - + 空格 + [x]

圖片

Markdown 語(yǔ)法：

![GitHub set up](http://zh.mweb.im/asset/img/set-up-git.gif)
格式: ![Alt Text](url)

Control + Shift + I 可插入Markdown語(yǔ)法。
如果是 MWeb 的文檔庫(kù)中的文檔，還可以用拖放圖片、CMD + V 粘貼、CMD + Option + I 導(dǎo)入這三種方式來(lái)增加圖片。
效果如下：

[站外圖片上傳中...(image-1f771f-1550542906397)]

MWeb 引入的特別的語(yǔ)法來(lái)設(shè)置圖片寬度，方法是在圖片描述后加 -w + 圖片寬度 即可，比如說(shuō)要設(shè)置上面的圖片的寬度為 140，語(yǔ)法如下：

[站外圖片上傳中...(image-c97dea-1550542906397)]

鏈接

Markdown 語(yǔ)法：

email <example@example.com>
[GitHub](http://github.com)
自動(dòng)生成連接  <http://www.github.com/>

Control + Shift + L 可插入Markdown語(yǔ)法。
如果是 MWeb 的文檔庫(kù)中的文檔，拖放或CMD + Option + I 導(dǎo)入非圖片時(shí)，會(huì)生成連接。
效果如下：

Email 連接： example@example.com
連接標(biāo)題Github網(wǎng)站
自動(dòng)生成連接像： http://www.github.com/ 這樣

區(qū)塊引用

Markdown 語(yǔ)法：

某某說(shuō):
> 第一行引用
> 第二行費(fèi)用文字

CMD + Shift + B 可插入Markdown語(yǔ)法。
效果如下：

某某說(shuō):

第一行引用
第二行費(fèi)用文字

行內(nèi)代碼

Markdown 語(yǔ)法：

像這樣即可：`<addr>` `code`

CMD + K 可插入Markdown語(yǔ)法。
效果如下：

像這樣即可：<addr> code

多行或者一段代碼

Markdown 語(yǔ)法：

```js
function fancyAlert(arg) {
    if(arg) {
    $.facebox({div:'#foo'})
    }

}
```

CMD + Shift + K 可插入Markdown語(yǔ)法。
效果如下：

function fancyAlert(arg) {
    if(arg) {
    $.facebox({div:'#foo'})
    }

}

順序圖或流程圖

Markdown 語(yǔ)法：

```sequence
張三->李四: 嘿，小四兒, 寫(xiě)博客了沒(méi)?
Note right of 李四: 李四愣了一下，說(shuō)：
李四-->張三: 忙得吐血，哪有時(shí)間寫(xiě)。
```

```flow
st=>start: 開(kāi)始
e=>end: 結(jié)束
op=>operation: 我的操作
cond=>condition: 確認(rèn)？

st->op->cond
cond(yes)->e
cond(no)->op
```

效果如下（ Preferences - Themes - Enable sequence & flow chart 才會(huì)看到效果 ）：

張三->李四: 嘿，小四兒, 寫(xiě)博客了沒(méi)?
Note right of 李四: 李四愣了一下，說(shuō)：
李四-->張三: 忙得吐血，哪有時(shí)間寫(xiě)。

st=>start: 開(kāi)始
e=>end: 結(jié)束
op=>operation: 我的操作
cond=>condition: 確認(rèn)？

st->op->cond
cond(yes)->e
cond(no)->op

更多請(qǐng)參考：http://bramp.github.io/js-sequence-diagrams/, http://adrai.github.io/flowchart.js/

表格

Markdown 語(yǔ)法：

第一格表頭 | 第二格表頭
--------- | -------------
內(nèi)容單元格 第一列第一格 | 內(nèi)容單元格第二列第一格
內(nèi)容單元格 第一列第二格 多加文字 | 內(nèi)容單元格第二列第二格

效果如下：

第一格表頭 第二格表頭
內(nèi)容單元格 第一列第一格 內(nèi)容單元格第二列第一格
內(nèi)容單元格 第一列第二格 多加文字 內(nèi)容單元格第二列第二格

刪除線

Markdown 語(yǔ)法：

加刪除線像這樣用： 刪除這些

效果如下：

加刪除線像這樣用： 刪除這些

分隔線

以下三種方式都可以生成分隔線：

效果如下：

MathJax

Markdown 語(yǔ)法：

塊級(jí)公式：
$$  x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

\\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } } \\]

行內(nèi)公式： $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

效果如下（Preferences - Themes - Enable MathJax 才會(huì)看到效果）：

塊級(jí)公式：
x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a}

\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } } \]

行內(nèi)公式： \Gamma(n) = (n-1)!\quad\forall n\in\mathbb N

腳注（Footnote）

Markdown 語(yǔ)法：

這是一個(gè)腳注：[^sample_footnote]

效果如下：

這是一個(gè)腳注：[1]

  1. 這里是腳注信息 ?

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 最近對(duì)github的README.md文件頗為感興趣。便寫(xiě)下這貼，幫助更多的還不會(huì)編寫(xiě)README文件的同學(xué)們。R...
    GB_speak閱讀 1,496評(píng)論 0贊 7
  • =================================================該文件用來(lái)測(cè)試和...
    zhouhao_180閱讀 4,159評(píng)論 2贊 3
  • README 該文件用來(lái)測(cè)試和展示書(shū)寫(xiě)README的各種markdown語(yǔ)法。GitHub的markdown語(yǔ)法在...
    Albert陳凱閱讀 471評(píng)論 0贊 0
  • 今天讓朋友給幫忙打印了一年級(jí)古詩(shī)，帶回家后閨女喜歡的翻了翻說(shuō):媽媽，我想要古詩(shī)卡。我說(shuō)都一樣的，古詩(shī)卡上的跟你們老...
    廈小二年級(jí)七班馬昕凱媽媽閱讀 179評(píng)論 0贊 1
  • 真正偉大的攝影不一定有多好的設(shè)備，多準(zhǔn)確的曝光，多完美的構(gòu)圖，一定有個(gè)不平凡的故事。 用故事見(jiàn)證攝影的力量 作為醫(yī)...
    永動(dòng)的風(fēng)車(chē)閱讀 414評(píng)論 0贊 2

友情鏈接更多精彩內(nèi)容