GitHub ReadME.md
Posted yezhanpeng
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了GitHub ReadME.md相关的知识,希望对你有一定的参考价值。
GitHub ReadME.md
GitHub ReadME.md Grammar
最近提交GitHub时发现有些人的ReadME.md写的非常漂亮,很好奇他们是怎么做到的,于是就搜了一下,原来ReadME.md不仅仅是随便写写的,它是由其特殊的语法的叫Markdown,刚好hexo写文章用的也是Markdown,所以这里列出一些基本的语法,以便于以后写ReadME.md时参考。
二、编辑基本语法 (注意??中间需要有一个空格 )
1、字体格式强调
我们可以使用下面的方式给我们的文本添加强调的效果
1 |
*强调* (示例:斜体) |
标题等级
关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。例如:
1 |
# 一级标题 |
2、代码
1
|
`<hello world>`
|
3、代码块高亮
三个反引号标签
4、表格 (建议在表格前空一行,否则可能影响表格无法显示)
1 |
表头 | 表头 | 表头 |
5、其他引用
图片
1 |
![图片名称](https://www.baidu.com/img/bd_logo1.png) |
6、列表
1 |
1. 项目1 |
7、换行(建议直接在前一行后面补两个空格)
直接回车不能换行,
可以在上一行文本后面补两个空格,
这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果,不过这个行间距有点大。
8、引用
1 |
> 第一行引用文字 |
以上是关于GitHub ReadME.md的主要内容,如果未能解决你的问题,请参考以下文章
GitHub 项目中的 README 和 README.md 有啥区别?