GitHub上README.md编写教程（基本语法）

今天在编写github中的readme.md文档时，发现自己写的和别人写的样式完全不一样，自己的好难看，于是百度了一番，很多都是转载的别人13年的博客，其中还发现一片17年写的原创，本以为发现了一个新的文章，结果发现其实就是转载的别人13年的博客，一个字都没修改居然可以编辑为原创，真心服了哪位仁兄了，本来打算在他文章底部评论的，最后想想算了吧。一番百度后，根据他人的博客重新归正了下。

参考博客：

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

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

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

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下面代码去看显示结果：

3. 1、在文本下面加上 等于号 = ，那么上方的文本就变成了大标题。等于号的个数无限制，但一定要大于0个哦。。

4. 2、在文本下面加上 下划线 - ，那么上方的文本就变成了中标题，同样的 下划线个数无限制。

5. 3、要想输入=号，上面有文本而不让其转化为大标题，则需要在两者之间加一个空行。

6. 另一种方法：（推荐这种方法；注意⚠️中间需要有一个空格）

7. 关于标题还有等级表示法，分为六个等级，显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #，二级标题有两个# ，以此类推。

29. protected void onDestroy() {

30. EventBus.getDefault().unregister(this);

34. 4、表格 （建议在表格前空一行，否则可能影响表格无法显示）

50. * 项目1 （一个*号会显示为一个黑点，注意⚠️有空格，否则直接显示为*项目1）

好了，以上的语法已经能基本满足你写github中的README.md说明文档了。