为项目编写README.md文件
来源:互联网 发布:网络科学导论pdf 编辑:程序博客网 时间:2024/04/27 22:18
了解一个项目,恐怕首先都是通过其Readme文件了解信息。如果你以为Readme文件都是随便写写的那你就错了。github,oschina git gitcafe的代码托管平台上的项目的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 | 单元格内容
如果直接记语法,那似乎困难了些。这里OneCoder推荐两个Markdown的编辑器。
在线编辑器:stackedit
网址:https://stackedit.io/
Mac下离线编辑器Mou
下载地址:http://mouapp.com/
0 0
- 为项目编写Readme.MD文件
- 为项目编写Readme.MD文件
- 为项目编写Readme.MD文件
- 为项目编写Readme.MD文件
- 为项目编写README.md文件
- 为项目编写Readme.MD文件
- 为项目编写Readme.MD文件
- 【Github】为项目编写Readme.MD文件
- 如何编写github项目的README.md文件?
- GitHub如何编写README.md项目自述文件
- github上README.md文件如何编写
- 【GitHub】README.MD 编写
- 编写README.md文档
- readme.md文件示例
- README.md文件使用
- GitHub上的Readme.md文件的编写
- GitHub中README.md文件编写的基本用法
- Markdown编写github README.md
- 【转】用C#实现的条形码和二维码编码解码器
- css样式的层叠和继承
- BroadCastReceiver 简介
- spring mvc <mvc:annotation-driven>配置使用出现问题
- 如何选用更适合用的TVS瞬间抑制二极管
- 为项目编写README.md文件
- setTimeout()和setInterval() 何时被调用执行
- Android酷炫实用的开源框架(UI框架)
- 机器学习 之 一句话解释 关键概念
- 运用JS设置cookie、读取cookie、删除cookie
- iOS 读取图片的各种方法
- Android Studio使用OpenCV的配置方法
- xml和json相互转换的代码
- stm32Flash模拟eeprom心得(原创)