了解一个项目,恐怕首先都是通过其Readme文件了解信息。如果你以为Readme文件都是随便写写的那你就错了。github,oschina git gitcafe的代码托管平台上的项目的Readme.MD文件都是有其特有的语法的。称之为Markdown语法。
在线编辑器:stackedit
网址:https://stackedit.io/
Mac下离线编辑器Mou
下载地址:http://mouapp.com/
编辑README
打开你的GitHub的某个项目,我们可以直接在线编辑你的README文件,如果你已经有了这个文件,则在文件目录中直接点击它,如果你还没有这个文件那么点击项目名称右边的一个按钮,来添加新文件:
如果已经有了这个文件,点击文件,文件右上角
基本语法:
在文本下面加上 等于号 = ,那么上方的文本就变成了大标题。
中标题 减号-
注意:如果你只输入了等于号=,但其上方无文字,那么就只会显示一条直线。如果上方有了文字,但你又只想显示一条横线,而不想把上方的文字转义成大标题的话,在等于号=的下一行必须为空行
如果你只输入了短横线(减号)-,其上方无文字,必须要写三个减号以上。其显示为虚线(*和_三个以上效果相同)
多级标题
#一级标题##二级标题###三级标题####四级标题#####五级标题######六级标题
换行
内容换行的时候不能直接通过回车,需要用标签<br>
文字高亮
文字高亮 `需要高亮的文字` 这非单引号,为波浪线
超链接
[ 要显示的文字 ]( 链接的地址 )鼠标悬停显示的文本,在URL之后 用双引号括起来一个字符串
原点符号
*开头加上空格
有缩进的原点符号前面加Tab
缩进
>符,可以有多级缩进
插入图片
![](图片url)
插入项目中的图片
https://github.com/ 你的用户名 / 你的项目名 / raw / 分支名 / 存放图片的文件夹 / 该文件夹下的图片
图片加超链接
[![任意表示名]](url)
[任意表示名,必须和上一句相同]:url "悬停时显示的内容"
插入代码段
第一行和最后一行用` ``,中间为代码段,注意为 波浪线+空格+两个波浪线
代码高亮为连续三个波浪线```之后接语言类型(Java、c、JavaScript、Bash、c++(cpp))