Git学习:Readme文档的编写
前言
该文是关于在Github下创建好仓库,并且将项目文件上传到仓库后,如何去编写好一份优秀的Readme文件,Readme文件的编写使用Markdown编辑模式撰写,和****官方博客撰写其实差不多,所以会了****的Markdown撰写其实差不多Readme也会,只不过两者可能在操作上或其他地方有些许小不同,但都是大同小异,****只是让编写更加人性化更加简单,Github上的编写就比较原始了,必须按照语言规则一点一点的打出来。
一、Markdown编写工具
这里推荐的Markdown编写工具是StackEdit,当然其实我觉得****也可以用来写,但我们还是返璞归真追求真正的Markdown编写比较好。这里的StackEdit不需要下载什么软件可以直接网页直接编写,这里贴出StackEdit工具的网址StackEdit工具
二、语言规则
这边简要概述一些基本常用的语言编写规则
1、标题Size:
#一级大标题
##二级大标题
###三级大标题
以此类推
2、字体加粗:
在加粗字前后加两个星号**
3、标点
-内容(一个负号符号后面加内容即可在内容前加点号)
4、添加图片
先把要的图片传到Issues中得到url链接,底下有个Attach files上传图片,之后得到如下链接即图片链接,然后复制链接到Readme文件中即可显示图片
5、表格形式
如下图输入竖号即可形成表格
三、结语
以上只是个人总结的简单Readme的编写,具体还可以使Readme内容更加美化,详情可以参考网上资源,本文内容甚少适用于简单的Readme编写,如有不当之处还请谅解。