参考博客: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说明文档了。编辑器