https://blog.csdn.net/qq_31796651/article/details/80803599

今天在編寫github中的readme.md文件時，發現自己寫的和別人寫的樣式完全不一樣，自己的好難看，於是百度了一番，很多都是轉載的別人13年的部落格，其中還發現一片17年寫的原創，本以為發現了一個新的文章，結果發現其實就是轉載的別人13年的部落格，一個字都沒修改居然可以編輯為原創，真心服了哪位仁兄了，本來打算在他文章底部評論的，最後想想算了吧。一番百度後，根據他人的部落格重新歸正了下。

參考部落格：

https://blog.csdn.net/zhao_jing_bo/article/details/68063070

https://blog.csdn.net/baochanghong/article/details/51984862

README檔案字尾名為md；md是markdown的縮寫，markdown是一種編輯部落格的語言。

順便推薦幾款編輯器：

（推薦）直接在csdn寫文章選擇Markdown編輯器：https://mp.csdn.net/mdeditor?

線上編輯器：stackedit

網址：http://mahua.jser.me/

網址：https://stackedit.io/

Mac下離線編輯器Mou

下載地址（不支援Mac Sierra版本）：http://mouapp.com/

MacDown 下載地址：https://macdown.uranusjr.com/

還有一種可以直接在android studio上進行編輯：參考他人部落格：https://www.jianshu.com/p/3a79fe462ffb

自動生成目錄
自動根據markdown語法識別標題生成目錄，點選目錄可以直接跳轉到指定位置

關於Markdown的基本編寫語法，我直接以程式碼的形式展示，你可以直接copy下面程式碼去看顯示結果：

一、標題寫法：
第一種方法：
1、在文字下面加上 等於號 = ，那麼上方的文字就變成了大標題。等於號的個數無限制，但一定要大於0個哦。。
2、在文字下面加上 下劃線 - ，那麼上方的文字就變成了中標題，同樣的 下劃線個數無限制。
3、要想輸入=號，上面有文字而不讓其轉化為大標題，則需要在兩者之間加一個空行。
另一種方法：（推薦這種方法；注意⚠️中間需要有一個空格）
關於標題還有等級表示法，分為六個等級，顯示的文字大小依次減小。不同等級之間是以井號 # 的個數來標識的。一級標題有一個 #，二級標題有兩個# ，以此類推。
例如：
# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題
二、編輯基本語法
1、字型格式強調
我們可以使用下面的方式給我們的文字新增強調的效果
*強調* (示例：斜體)
_強調_ (示例：斜體)
**加重強調** (示例：粗體)
__加重強調__ (示例：粗體)
***特別強調*** (示例：粗斜體)
___特別強調___ (示例：粗斜體)
2、程式碼
`<hello world>`
3、程式碼塊高亮
```
@Override
protected void onDestroy() {
EventBus.getDefault().unregister(this);
super.onDestroy();
}
```
4、表格 （建議在表格前空一行，否則可能影響表格無法顯示）

表頭 | 表頭 | 表頭
---- | ----- | ------
單元格內容 | 單元格內容 | 單元格內容
單元格內容 | 單元格內容 | 單元格內容

5、其他引用
圖片
連結
[連結名稱](https://www.baidu.com/)
6、列表
1. 專案1
2. 專案2
3. 專案3
* 專案1 （一個*號會顯示為一個黑點，注意⚠️有空格，否則直接顯示為*專案1）
* 專案2

7、換行（建議直接在前一行後面補兩個空格）
直接回車不能換行，
可以在上一行文字後面補兩個空格，
這樣下一行的文字就換行了。
或者就是在兩行文字直接加一個空行。
也能實現換行效果，不過這個行間距有點大。

8、引用
> 第一行引用文字
> 第二行引用文字
好了，以上的語法已經能基本滿足你寫github中的README.md說明文件了。
————————————————
版權宣告：本文為CSDN博主「snowzhao210」的原創文章，遵循CC 4.0 BY-SA版權協議，轉載請附上原文出處連結及本宣告。
原文連結：https://blog.csdn.net/qq_31796651/article/details/80803599