Github上README.md的语法
首先,README文件后缀名为md。md是markdown的缩写,是一种编辑博客的语言。不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM。
一、标题
(1)规范的README文件开头都写上一个标题,这被称为大标题
大标题
====
在文本下面加上 = ,那么上方的文本就变成了大标题,等于号的个数无限制。
(2)比大标题低一级的是中标题
中标题
-------
在文本下面加上 - ,那么上方的文本就变成了中标题,同样的 下划线个数无限制。
(3)标题的等级表示法
#一级标题
##二级标题
###三级标题
####四级标题
#####五级标题
######六级标题
关于标题的等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以 # 的个数来标识的。(注意:#和标题名称要并排写作一行)
(4)补充
如果输入=,但其上方无文字,则其只会显示一条直线。
如果上方有了文字,上却只需显示一条横线,而不想把方的文字转义成大标题,那么你就要在=和文字间补一个空行。
附:补空行,是很常用的用法,当你不想上下两个不同的布局方式交错到一起的时候,就要在两种布局之间补一个空行。
如果输入短横线-,其上方无文字,那么要显示直线,必须要写三个减号以上。
与等于号的显示效果不同,它显示出来是虚线而不是实线。同减号作用相同的还有*和_,同样的这两者符号也要写三个以上才能显示一条虚横线。
二、文本
(1)普通文本
直接输入的文字就是普通文本。需要注意的是要换行的时候不能直接通过回车来换行,需要使用<br>(或者<br/>)。
如果要显示超链接,就直接输入这个链接的URL,显示出来会自动变成可链接的形式。
(2)单行文本
使用两个Tab符实现单行文本。
(3)多行文本
多行文本和单行文本异曲同工,只要在每行行首加两个Tab。
(4)部分文字的高亮
让文字高亮显示,来起到突出强调的作用,那么可以把它用 ` ` 包围起来。(注意这不是单引号,而是Tab上方,数字1左边的按键)
(5)文字超链接
给一段文字加入超链接的格式是: [ 要显示的文字 ]( 链接的地址 )。
(6)插入符号
a.圆点符,在*后加一个空格即表示圆点符,若不加空格则为普通*号。
b.二级圆点和三级圆点,在此基础上多加一个Tab。
三、插入图片
(1)来源于网络的图片
语法:
( ) 其中是图片的URL,[]里可以加入一些 标识性的信息。
(2)GitHub仓库里的图片
语法:
(3)给图片加上超链接
语法:
[![image]](http://www.github.com/)
[image]: http://github.com/github.png "github"
四、插入代码片段
在代码的上一行和下一行用` `` 标记。
``` 不是三个单引号,而是数字1左边,Tab键上面的键。

浙公网安备 33010602011771号