GitHub上README.md教程




ReadMe.md格式

关于标题





显示文本

单行文本


 
换行 【只能加在文字开头,末尾没有用】    回车不能换行
两个 tab 实现单行文本
有黑边的


多行文本

每行 加 两个tab  多行文本

``    部分 高亮    如:`YOU` 【键盘上tab顶上的那个】




文字超链接

超链接    [我的博客](http://blog.csdn.net/guodongxiaren) 
超链接 加鼠标悬停     [我的博客](http://blog.csdn.net/guodongxiaren "悬停显示”)




插入符号

圆点符

* 文字  【*后面有一个空格】
  
此外还有二级圆点和三级圆点。就是多加一个Tab。


缩进

>
>>
>>>


插入图片

![](http://www.baidu.com/img/bdlogo.gif)  

即 叹号! + 方括号[ ] + 括号( ) 其中叹号里是图片的URL。

如果不加叹号! ,就会变成普通文本baidu了。

在方括号里可以加入一些 标识性的信息,比如

![baidu](http://www.baidu.com/img/bdlogo.gif)  



GitHub仓库里的图片

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


给图片加上超链接

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


插入代码片段 

```语言

```结尾







[题外话]在GitHub上用Gist写日记吧


看了这么多markdown的语法,你一定不满足于仅仅写一个README文件了,开始跃跃欲试想实际用markdown语法来编写博客或文章了吧。的确,网上也有依托或者支持markdown语法的博客。但是呢,更方便的是,你可以借助GitHub本身就有的一个功能——Gist。

Gist是以文件为单位的,不是以项目为单位的。而且与普通的GitHub上建的仓库不同,Gist是private的哦。普通的项目默认都是public的,要想弄成private貌似还要交钱的样子。既然是private那么用来写写日记,是极好的。

GitHub网页的顶部有


点进去:


这就是你可以编辑的私有文件,它不仅支持Text文本,还支持各种编程语言呢!当然也包括markdown。输入文件名:


最后保存,选中 Create Secret Gist 就是私有的喽。

我在GitHub上为本文建的一个项目,供大家查看代码即具体效果:https://github.com/guodongxiaren/test


ReadMe.md格式

关于标题





显示文本

单行文本


 
换行 【只能加在文字开头,末尾没有用】    回车不能换行
两个 tab 实现单行文本
有黑边的


多行文本

每行 加 两个tab  多行文本

``    部分 高亮    如:`YOU` 【键盘上tab顶上的那个】




文字超链接

超链接    [我的博客](http://blog.csdn.net/guodongxiaren) 
超链接 加鼠标悬停     [我的博客](http://blog.csdn.net/guodongxiaren "悬停显示”)




插入符号

圆点符

* 文字  【*后面有一个空格】
  
此外还有二级圆点和三级圆点。就是多加一个Tab。


缩进

>
>>
>>>


插入图片

![](http://www.baidu.com/img/bdlogo.gif)  

即 叹号! + 方括号[ ] + 括号( ) 其中叹号里是图片的URL。

如果不加叹号! ,就会变成普通文本baidu了。

在方括号里可以加入一些 标识性的信息,比如

![baidu](http://www.baidu.com/img/bdlogo.gif)  



GitHub仓库里的图片

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


给图片加上超链接

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


插入代码片段 

```语言

```结尾







[题外话]在GitHub上用Gist写日记吧


看了这么多markdown的语法,你一定不满足于仅仅写一个README文件了,开始跃跃欲试想实际用markdown语法来编写博客或文章了吧。的确,网上也有依托或者支持markdown语法的博客。但是呢,更方便的是,你可以借助GitHub本身就有的一个功能——Gist。

Gist是以文件为单位的,不是以项目为单位的。而且与普通的GitHub上建的仓库不同,Gist是private的哦。普通的项目默认都是public的,要想弄成private貌似还要交钱的样子。既然是private那么用来写写日记,是极好的。

GitHub网页的顶部有


点进去:


这就是你可以编辑的私有文件,它不仅支持Text文本,还支持各种编程语言呢!当然也包括markdown。输入文件名:


最后保存,选中 Create Secret Gist 就是私有的喽。

我在GitHub上为本文建的一个项目,供大家查看代码即具体效果:https://github.com/guodongxiaren/test

你可能感兴趣的:(github,readme,格式)