參考博客:android
https://blog.csdn.net/zhao_jing_bo/article/details/68063070git
https://blog.csdn.net/baochanghong/article/details/51984862github
README文件後綴名爲md;md是markdown的縮寫,markdown是一種編輯博客的語言。markdown
順便推薦幾款編輯器:
在線編輯器:stackedit
網址:http://mahua.jser.me/
網址:https://stackedit.io/
Mac下離線編輯器Mou
下載地址:http://mouapp.com/
還有一種能夠直接在android studio上進行編輯:參考他人博客:https://www.jianshu.com/p/3a79fe462ffb
關於Markdown的基本編寫語法,我直接以代碼的形式展現,你能夠直接copy下面代碼去看顯示結果:
1、標題寫法:
第一種方法:
一、在文本下面加上 等於號 = ,那麼上方的文本就變成了大標題。等於號的個數無限制,但必定要大於0個哦。。
二、在文本下面加上 下劃線 - ,那麼上方的文本就變成了中標題,一樣的 下劃線個數無限制。
三、要想輸入=號,上面有文本而不讓其轉化爲大標題,則須要在二者之間加一個空行。
另外一種方法:(推薦這種方法;注意⚠️中間須要有一個空格)
關於標題還有等級表示法,分爲六個等級,顯示的文本大小依次減少。不一樣等級之間是以井號 # 的個數來標識的。一級標題有一個 #,二級標題有兩個# ,以此類推。
例如:app
# 一級標題 ## 二級標題 ### 三級標題 #### 四級標題 ##### 五級標題 ###### 六級標題 2、編輯基本語法 一、字體格式強調 咱們能夠使用下面的方式給咱們的文本添增強調的效果 *強調* (示例:斜體) _強調_ (示例:斜體) **加劇強調** (示例:粗體) __加劇強調__ (示例:粗體) ***特別強調*** (示例:粗斜體) ___特別強調___ (示例:粗斜體) 二、代碼 `<hello world>` 三、代碼塊高亮 ``` @Override protected void onDestroy() { EventBus.getDefault().unregister(this); super.onDestroy(); } ``` 四、表格 (建議在表格前空一行,不然可能影響表格沒法顯示) 表頭 | 表頭 | 表頭 ---- | ----- | ------ 單元格內容 | 單元格內容 | 單元格內容 單元格內容 | 單元格內容 | 單元格內容 五、其餘引用 圖片  連接 [連接名稱](https://www.baidu.com/) 六、列表 1. 項目1 2. 項目2 3. 項目3 * 項目1 (一個*號會顯示爲一個黑點,注意⚠️有空格,不然直接顯示爲*項目1) * 項目2 七、換行(建議直接在前一行後面補兩個空格) 直接回車不能換行, 能夠在上一行文本後面補兩個空格, 這樣下一行的文本就換行了。 或者就是在兩行文本直接加一個空行。 也能實現換行效果,不過這個行間距有點大。 八、引用 > 第一行引用文字 > 第二行引用文字
好了,以上的語法已經能基本知足你寫github中的README.md說明文檔了。編輯器