您的位置:首页 > 其它

为项目编写Readme.MD文件(转自OneCoder)

2015-07-25 11:09 169 查看
点击原文---> 为项目编写Readme.MD文件

两个Markdown的编辑器。
在线编辑器:stackedit
网址:https://stackedit.io/ Mac下离线编辑器Mou
下载地址:http://mouapp.com/

也可以手动用语法写,下面是语法

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 | 单元格内容

内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: