注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

旷世的忧伤

不与夏虫语寒,不与曲人语道,因为生命缺乏言说的条件......

 
 
 

日志

 
 

Readme文件格式  

2015-01-18 21:15:07|  分类: 版本控制工具 |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |

在github,oschina git,gitcafe等的代码托管平台上的项目的README.md文件都有其特有的语法。称之为Markdown语法。基本大致规则如下:

标题
1. 大标题  
===================================  
大标题一般显示工程名,只要在标题下面跟上=====即可  

2. 中标题  
-----------------------------------  
中标题一般显示重点项,只要在标题下面输入------即可  

3. 小标题  
小标题的格式为 ### 小标题,注意#和标题字符中间要有空格,不同个数的#可以代表不同标题的级别:  
# 这是 H1 <一级标题>
## 这是 H2 <二级标题>
###### 这是 H6 <六级标题>

文字格式
**这是文字粗体格式**
*这是文字斜体格式*
~~在文字上添加删除线~~

列表

1. 无序列表
* 项目1
* 项目2
* 项目3

- 项目1
- 项目2
- 项目3

2. 有序列表
1. 项目1
2. 项目2
3. 项目3
   * 项目1
   * 项目2

图片
![图片名称](http://gitcafe.com/image.png)

链接
[链接名称](http://gitcafe.com)

引用
> 第一行引用文字
> 第二行引用文字

水平线
***

---

代码
`<hello world>`

代码块高亮
```ruby
  def add(a, b)
    return a + b
  end
```
表格
  表头  | 表头
  ------------- | -------------
 单元格内容  | 单元格内容
 单元格内容l  | 单元格内容

参考资料:
 http://www.coderli.com/write-readme-for-your-project/
  评论这张
 
阅读(12)| 评论(0)
推荐 转载

历史上的今天

在LOFTER的更多文章

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2018