GitHub上README.md编写教程（基本语法） |
您所在的位置：网站首页 › 用工具怎么写 › GitHub上README.md编写教程（基本语法） |
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 README文件后缀名为md；md是markdown的缩写，markdown是一种编辑博客的语言。 顺便推荐几款编辑器： （推荐）直接在csdn写文章选择Markdown编辑器：https://mp.csdn.net/mdeditor? 在线编辑器：stackedit 网址：MaHua 在线markdown编辑器 网址：StackEdit – In-browser Markdown editor Mac下离线编辑器Mou 下载地址（不支持Mac Sierra版本）：Coming Soon MacDown 下载地址：MacDown: The open source Markdown editor for macOS 还有一种可以直接在android studio上进行编辑：参考他人博客：Android Studio MarkDown风格README的正确打开姿势 - 简书 自动生成目录自动根据markdown语法识别标题生成目录，点击目录可以直接跳转到指定位置
关于Markdown的基本编写语法，我直接以代码的形式展示，你可以直接copy下面代码去看显示结果： 一、标题写法： 第一种方法： 1、在文本下面加上 等于号 = ，那么上方的文本就变成了大标题。等于号的个数无限制，但一定要大于0个哦。。 2、在文本下面加上 下划线 - ，那么上方的文本就变成了中标题，同样的 下划线个数无限制。 3、要想输入=号，上面有文本而不让其转化为大标题，则需要在两者之间加一个空行。 另一种方法：（推荐这种方法；注意⚠️中间需要有一个空格） 关于标题还有等级表示法，分为六个等级，显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #，二级标题有两个# ，以此类推。 例如： # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 二、编辑基本语法 1、字体格式强调 我们可以使用下面的方式给我们的文本添加强调的效果 *强调* (示例：斜体) _强调_ (示例：斜体) **加重强调** (示例：粗体) __加重强调__ (示例：粗体) ***特别强调*** (示例：粗斜体) ___特别强调___ (示例：粗斜体) 2、代码 `` 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说明文档了。 |
【本文地址】
今日新闻 |
推荐新闻 |