開始之前
是不是在github上看項(xiàng)目的時(shí)候第一眼就要看項(xiàng)目介紹？ 是不是經(jīng)常在某些項(xiàng)目的代碼里面看到一個(gè)README.MD文檔 卻不知道怎么寫？
你是不是不知道，反正我是的。
作為一個(gè)程序員，可能寫了幾年之后都會(huì)或多或少的需要寫一份可以幫助別人快速了解你的項(xiàng)目的文檔，這個(gè)時(shí)候如果你用txt或者word來寫 ，是不是有點(diǎn)不夠逼格，又或排版略顯麻煩？
那么它來了 —— MarkDown
Markdown是一種輕量級的標(biāo)記語言，使用極為簡單的語法就可以實(shí)現(xiàn) 段落，文字字體，超鏈接，圖片，代碼塊，表格 等等等 模塊。非常的簡單實(shí)用幫助我們快速編輯一個(gè)HTML文檔。
快速開始
-
標(biāo)題
標(biāo)題的實(shí)用很常見，像html的“H”標(biāo)簽一樣 h1-h6表達(dá)標(biāo)題字體大小 ，同理，在 md中使用 “#” 來表達(dá)標(biāo)題級別，通過數(shù)量來決定標(biāo)題大小 ，1個(gè)“#”即代表 1級標(biāo)題，即最大的標(biāo)題。
只需要在想要作為標(biāo)題的文字前加對應(yīng)的“#”數(shù)量即可以完成。（注意：“#”號(hào)的最后，文字前需要加一個(gè)空格 這個(gè)最好是加上 因?yàn)橛幸恍┚庉嬈骺赡懿患訜o法識(shí)別 ）
一級標(biāo)題
# 一級標(biāo)題
二級標(biāo)題
## 二級標(biāo)題
三級標(biāo)題
###三級標(biāo)題
四級標(biāo)題
#### 四級標(biāo)題
五級標(biāo)題
##### 五級標(biāo)題
六級標(biāo)題
###### 六級標(biāo)題
是不是很簡單？
-
字體
字體是文章很重要的一部分，有些需要讀者重點(diǎn)了解的內(nèi)容，只需要將字體像這樣 加粗 ，變斜，或者又粗又斜，又或者修改文檔增加注釋廢棄的代碼。
如此表達(dá)是不是很清晰？
敲黑板
粗體
普通：粗體
加粗：粗體
**粗體**
斜體
普通：斜體
變斜：斜體
*斜體*
又粗又斜
普通：又粗又斜
粗斜：又粗又斜
***又粗又斜***
刪除線 廢棄線
普通：刪除，廢棄
刪除，廢棄：刪除，廢棄
~~刪除，廢棄~~
-
引用
有時(shí)候 需要引用別的文章/句式/代碼等 可以使用引用塊 表達(dá)
人到中年不得已 保溫杯里泡枸杞 -某位程序員
> 人到中年不得已 保溫杯里泡枸杞 -某位程序員
只需要在引用之前 加一個(gè)“>”即可
-
分割線
---
或
***
兩種方式都可以實(shí)現(xiàn)分割線。
-
圖片
圖片有兩種形式: 本地圖片 網(wǎng)絡(luò)圖片
寫法實(shí)際是一樣的
如果是本地圖片 圖片url替換成為圖片本地路徑就可以。
-
超鏈接
這里會(huì)跳轉(zhuǎn)到非常神奇的一個(gè)地方，在這里我們可以遨游互聯(lián)網(wǎng)
[這里會(huì)跳轉(zhuǎn)到非常神奇的一個(gè)地方，在這里我們可以遨游互聯(lián)網(wǎng)](https://www.baidu.com)
[鏈接文字](鏈接)
沒錯(cuò)，超鏈接與加載圖片的寫法只差了一個(gè)“!”
-
列表
列表其實(shí)是一個(gè)非常常用的功能 ，列表的排版會(huì)讓文章調(diào)理更清晰，更方便劃清重點(diǎn)。
- A
- B
- C
只需要在內(nèi)容前加“- ”（減號(hào)+空格）即可.
- A
- B
- C
-
表格
表格我就不多說了吧？直接上用法:
| 姓名 | 性別 | 年齡 | 專業(yè) |
|---|---|---|---|
| 二狗子 | 男 | 28 | android開發(fā)工程師 |
| 小美 | 女 | 18 | python開發(fā)工程師 |
| 鐵柱 | 未知 | 30 | java開發(fā)工程師 |
姓名|性別|年齡|專業(yè)
--|--|--|--
二狗子|男|28|android開發(fā)工程師
小美|女|18|python開發(fā)工程師
鐵柱|未知|30|java開發(fā)工程師
這也太簡單了吧？？？
-
代碼塊
public static void main(){
Log.d(TAG,"hello,md");
}
代碼塊用 ` 三個(gè)放在開頭 三個(gè)放在結(jié)尾，代碼放在中間即可。
像這樣：
```
public static void main(){
Log.d(TAG,"hello,md");
}
```
-
高級進(jìn)階
感謝小伙伴讀到了這里，下面我們來介紹一下高級進(jìn)階用法
高級的用法我也是在網(wǎng)上通過其他大神或者教學(xué)網(wǎng)站整理而來，如果有侵權(quán)行為，請私信我 ，我這面立即就會(huì)整改
-
轉(zhuǎn)義
Markdown 使用了很多特殊符號(hào)來表示特定的意義，如果需要顯示特定的符號(hào)則需要使用轉(zhuǎn)義字符，Markdown 使用反斜杠轉(zhuǎn)義特殊字符：
例如：
文本加粗
** 正常顯示星號(hào) **
**文本加粗**
\*\* 正常顯示星號(hào) \*\*
-
公式
數(shù)學(xué)公式這塊 我還有點(diǎn)沒太弄明白 等我弄明白了 我再回頭來分享給大家。
工具
工具其實(shí)在線的就有很多，能直接預(yù)覽你編輯的MD 。我個(gè)人更偏向使用本地的工具，編輯預(yù)覽起來更方便，功能也更強(qiáng)大一些。
在這里給大家推薦一個(gè)練習(xí)或者編輯使用的編輯器：
Typora-MD編輯器
這應(yīng)該是我用過的最好用的編輯器了，大家可以下載一下 平時(shí)練習(xí)使用。
我是一名android開發(fā)者，目前想考慮轉(zhuǎn)一下方向去做服務(wù)端架構(gòu)和代碼編寫，目前正在從頭開始學(xué)習(xí)java。
這個(gè)博客是剛剛注冊的， 哪怕雖然我已經(jīng)做了8年的程序員，但一直都在索取，現(xiàn)在希望在學(xué)習(xí)的過程中，記錄下來問題和經(jīng)驗(yàn)，來幫助更多需要幫助的人。
如需轉(zhuǎn)載，請注明出處:http://www.itdecent.cn/p/dc60eb4a4695
