Github编写README.md

简介

了解一个项目,恐怕首先都是通过其Readme文件了解信息。如果你以为Readme文件都是随便写写的那你就错了。github,oschinaGit gitcafe的代码托管平台上的项目的Readme.MD文件都是有其特有的语法的。称之为Markdown语法

Markdown 语法速查表

1 标题与文字格式
标题
# 这是 H1 <一级标题>
## 这是 H2 <二级标题>
###### 这是 H6 <六级标题>
文字格式
**这是文字粗体格式**
*这是文字斜体格式*
~~在文字上添加删除线~~
2 列表
无序列表
* 项目1
* 项目2
* 项目3
有序列表
1. 项目1
2. 项目2
3. 项目3
   * 项目1
   * 项目2
3 其它
图片
![图片名称](http://upload-images.jianshu.io/upload_images/1097226-6a6fbea43e82e7ac.png)
链接
[链接名称](http://gitcafe.com)
引用
> 第一行引用文字
> 第二行引用文字
水平线
***
代码
``
代码块高亮
```ruby
  def add(a, b)
    return a + b
  end
表格
  表头  | 表头
  ------------- | -------------
 单元格内容  | 单元格内容
 单元格内容l  | 单元格内容

推荐内部的Markdown介绍详情地址


结束语

到这里就结束了,如若不懂的话可以留言,也可以加入群讨论
喜欢的话 记得关注、收藏、点赞哟

群号:552048526

你可能感兴趣的:(Github编写README.md)