github的README.md文件格式

Posted AlanTao

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了github的README.md文件格式相关的知识,希望对你有一定的参考价值。

一.在线编辑器:stackedit

网址:https://stackedit.io/

README.md是使用Markdown语法。基本规则如下:

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

 

二.github测试

# Files

github update test 
> test github1
- test github2
**test github3!**

## Create files and folders
[test github4]
```
test github5
```
$$
test github6
$$

以上是关于github的README.md文件格式的主要内容,如果未能解决你的问题,请参考以下文章

MD文件

conding.net或github,readme.md添加图片

github 上 Python 包的 README 格式是啥?

如何在github中的readme.md加入项目截图

README.md文件 github Markdown语言详解 md文件用法和说明

GitHub 项目中的 README 和 README.md 有啥区别?