github中常用到的README.md写法笔记

xiaoxiao2021-03-01  4

最近在用gitlab,项目提交上去之后还是想着再写个文档来描述项目的主要业务。其实,这在github上经常用README.md文件来说明。 EADME文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。 不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM。 写法笔记 1、大标题的写法 大标题 ==== 大标题下方写"="后,就会变成大标题,"="个数不限,大于0即可 2、中标题的写法 中标题 ____ 中标题下方写"_"后,上面的文本就会变为中标题,中标题字段稍小一点,下划线个数大于0即可 除此之外,你也会发现大,中标题下面都有一条横线,没错这就是 = 和 - 的显示结果。 如果你只输入了等于号=,但其上方无文字,那么就只会显示一条直线。如果上方有了文字,但你又只想显示一条横线,而不想把上方的文字转义成大标题的话,那么你就要在等于号=和文字直接补一个空行。 补空行:是很常用的用法,当你不想上下两个不同的布局方式交错到一起的时候,就要在两种布局之间补一个空行。 如果你只输入了短横线(减号)-,其上方无文字,那么要显示直线,必须要写三个减号以上。不过与等于号的显示效果不同,它显示出来时虚线而不是实线。同减号作用相同的还有星号*和下划线_,同样的这两者符号也要写三个以上才能显示一条虚横线。 除此以外,关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。 注意井号#和标题名称要并排写作一行 实际上,前文所述的大标题和中标题是分别和一级标题和二级标题对应的。即大标题大小和一级标题相同,中标题大小和二级标题相同。 普通文本: 直接输入的文字就是普通文本。需要注意的是要换行的时候不能直接通过回车来换行,需要使用<br>(或者<br/>)。也就是html里面的标签。事实上,markdown支持一些html标签,你可以试试。当然如果你完全使用html来写的话,就丧失意义了,毕竟markdown并非专门做前端的,然而仅实现一般效果的话,它会比html写起来要简洁得多得多啦。 超链接: 直接写url,会自动转换成超链接 文字超链接 给一段文字加入超链接的格式是这样的 [ 要显示的文字 ]( 链接的地址 )。比如: 我的文本(http://sxabu.iteye.com) 待续。。。
转载请注明原文地址: https://www.6miu.com/read-3100190.html

最新回复(0)