github中的README.md写法学习

EADME文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。
不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM。

一、标题写法

1、带分割线标题

文字下方写等号"=“后,就会变成大标题,等号个数不小于1个即可,显示效果相同;
文字下方写减号”-"后,上面的文本就会变为中标题,中标题字段稍小一点。减号个数不小于1个即可,显示效果相同。
如图:

写法举例
效果

2、分级标题

标题有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。

注意井号#和标题名称要并排写作一行

实际上,前文所述的大标题和中标题是分别和一级标题和二级标题对应的。即大标题大小和一级标题相同,中标题大小和二级标题相同。
图例

二、分隔线写法

1、只显示一条直线

如果上方有了文字,但只想显示一条横线,而不想把上方的文字转义成大标题的话,那么你就要在等于号=和文字之间补一个空行,并加上3个或以上减号(或者下划线_,星号*)。如图:
写法
效果

2、显示圆点

文字下方补空行,加一个减号或星号,可显示一个圆点效果。

三、正文

单行文本:前面使用两个Tab

多行文本:每行行首加两个Tab

部分文字高亮:使用``包围,这个符号不是单引号,而是Tab上方,数字1左边那个按键的符号

文字超链接格式:要显示的文字,在URL之后用双引号括起来一个字符串,即鼠标悬停显示的文本,可不写

猜你喜欢

转载自blog.csdn.net/weixin_43888129/article/details/84852141
今日推荐