关于标题

规范的readme文件开头都写上一个标题,称之为大标题。

大标题

1
2
大标题
=====

“=”个数大于o并且渐增

中标题

1
2
中标题
-------

在文本下面加上 下划线 - ,那么上方的文本就变成了中标题,同样的 下划线个数无限制。

除此之外,你也会发现大,中标题下面都有一条横线,没错这就是 = 和 - 的显示结果。

补空行:是很常用的用法,当你不想上下两个不同的布局方式交错到一起的时候,就要在两种布局之间补一个空行。

如果你只输入了短横线(减号)-,其上方无文字,那么要显示直线,必须要写三个减号以上。不过与等于号的显示效果不同,它显示出来时虚线而不是实线。同减号作用相同的还有星号*和下划线_,同样的这两者符号也要写三个以上才能显示一条虚横线。

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


注意井号#和标题名称要并排写作一行,显示效果如图:

#一级标题

##二级标题

###三级标题

####四级标题

#####五级标题

######六级标题

1
2
3
4
5
6
#一级标题  
##二级标题
###三级标题
####四级标题
#####五级标题
######六级标题

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

显示文本

普通文本

直接输入的文字就是普通文本。需要注意的是要换行的时候不能直接通过回车来换行,需要使用‘
’(或者‘
’)。也就是html里面的标签。事实上,markdown支持一些html标签,你可以试试。当然如果你完全使用html来写的话,就丧失意义了,毕竟markdown并非专门做前端的,然而仅实现一般效果的话,它会比html写起来要简洁得多得多啦。

效果如图:
这是一段普通的文本,
直接回车不能换行,

要使用\

1
2
3
这是一段普通的文本,  
直接回车不能换行,<br>
要使用\<br>

注意第三行的
前加了反斜杠 \ 。目的就是像其他语言那样实现转义,也就是 < 的转义。

此外,要显示一个超链接的话,就直接输入这个链接的URL就好了。显示出来会自动变成可链接的形式的。

显示空格的小Tip

默认的文本行首空格都会被忽略的,但是如果你想用空格来排一下版的话怎么办呢,有个小技巧,那就是把你的输入法由半角改成全角就OK啦。

单行文本:

使用两个Tab符实现单行文本。

注意前面有两个Tab。在GitHub上单行文本显示效果如图:

大家好,我是新来的,请多多关照。
1
 

多行文本

多行文本和单行文本异曲同工,只要在每行行首加两个Tab

效果:

好的1
好的2
好的3
1
2
3
好的
好的
好的

部分文字的高亮

如果你想使一段话中部分文字高亮显示,来起到突出强调的作用,那么可以把它用 包围起来。注意这不是单引号,而是Tab上方,数字1左边的按键(注意使用英文输入法)。

效果:

我是pig

1
我是`pig`

文件超链接

给一段文字加入超链接的格式是这样的 要显示的文字 。比如:

1
[我的博客](https://home.cnblogs.com/u/willem-xin/)

你还可以给他加上一个鼠标悬停显示的文本。

1
[我的博客](http://blog.csdn.net/guodongxiaren "悬停显示")

即在URL之后 用双引号括起来一个字符串。同样要注意这里是英文双引号。

插入符号

###圆点符
效果:

  • 这是一个圆点
  • 这是一个圆点

上面这段的圆点是CSDN博客编辑器里面的符号列表。写文章在列出条目时经常用到。在GitHub的markdown语法里也支持使用圆点符。编辑的时候使用的是星号 *

1
2
3
* 昵称:果冻虾仁  
* 别名:隔壁老王
* 英文名:Jelly

要注意的是星号* 后面要有一个空格。否则显示为普通星号。上文的显示效果如图:

此外还有二级圆点和三级圆点。就是多加一个Tab。

效果:

  • 编程语言
    • 脚本语言
      • Python
        1
        2
        3
        * 编程语言
        * 脚本语言
        * Python

如果你觉得三级的结构还不够表达清楚的话,我们可以试着换一种形式,请看字符包围

缩进

效果:

数据结构

二叉树

平衡二叉树

满二叉树

1
2
3
4
5
>数据结构  
>>树
>>>二叉树
>>>>平衡二叉树
>>>>>满二叉树

当然比这个更一般的用法是这样。常常能在书籍里面看到的效果,比如引用别人的文章。直接看效果。

插入图片

来源于网络的图片

使用的最简单,最基本的语法是:


1
![baidu]{http://www.baidu.com/img/bdlogo.gif}

这个方括号里的baidu并不会对图像显示造成任何改动,如果你想达到鼠标悬停显示提示信息,那么可以仿照前面介绍的文本中的方法,就是这样:

效果:
baidu

1
![baidu](http://www.baidu.com/img/bdlogo.gif "百度logo")

GitHub仓库里的图片

有时候我们想显示一个GitHub仓库(或者说项目)里的图片而不是一张其他来源网络图片,因为其他来源的URL很可能会失效。那么如何显示一个GitHub项目里的图片呢?

其实与上面的格式基本一致的,所不同的就是括号里的URL该怎么写。

https://github.com/ 你的用户名 / 你的项目名 / raw / 分支名 / 存放图片的文件夹 / 该文件夹下的图片

这样一目了然了吧。比如:

1
![](https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif)

我在GitHub上的用户名guodongxiaren;有一个项目ImageCache;raw表示原数据的意思吧,不用管它;主分支master;项目里有一个文件夹Logo;Logo文件夹下有一张图片foryou.gif

给图片加上超链接

如果你想使图片带有超链接的功能,即点击一个图片进入一个指定的网页。那么可以这样写:

![baidu]
[baidu]:http://www.baidu.com/img/bdlogo.gif “百度Logo”

1
2
[![baidu]](http://baidu.com)  
[baidu]:http://www.baidu.com/img/bdlogo.gif "百度Logo"

这两句和前面的写法差异较大,但是也极易模仿着写出,就不过多介绍了。只需注意上下文中的 baidu 是你自己起的标识的名称,可以随意,但是一定要保证上下两行的 标识 是一致的。
这样就能实现 点击图片进入网页的功能了。

插入代码片段

我们需要在代码的上一行和下一行用` 标记。

``` 之后加上你的编程语言即可(忽略大小写)。c++语言可以写成c++也可以是php。看代码:
1
2
3
4
5
6

```Java
//java
public static void main(String agrs[]){
System.out.println("Hello World");
}

1
2
//c
int main(int argc,char *argv[])
1
echo "Hello World" #Bash
1
2
//JavaScript
document.getElementById("userId").innerHTML = "Welcome to JavaScript"
1
2
//cpp
string &operator+(const string& A,const string& B)