python的readme怎么写
答案:1 悬赏:10 手机版
解决时间 2021-02-28 23:48
- 提问者网友:沉默的哀伤
- 2021-02-28 11:14
python的readme怎么写
最佳答案
- 五星知识达人网友:蕴藏春秋
- 2021-02-28 12:35
了解一个项目,恐怕首先都是通过其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 其它
图片
![图片名称](mage.png)
链接
[链接名称]()
引用
> 第一行引用文字
> 第二行引用文字
水平线
***
代码
``
代码块高亮
```ruby
def add(a, b)
return a + b
end
```
表格
表头 | 表头
------------- | -------------
单元格内容 | 单元格内容
单元格内容l | 单元格内容
如果直接记语法,那似乎困难了些。这里OneCoder推荐两个Markdown的编辑器。
Markdown 语法速查表
1 标题与文字格式
标题
# 这是 H1 <一级标题>
## 这是 H2 <二级标题>
###### 这是 H6 <六级标题>
文字格式
**这是文字粗体格式**
*这是文字斜体格式*
~~在文字上添加删除线~~
2 列表
无序列表
* 项目1
* 项目2
* 项目3
有序列表
1. 项目1
2. 项目2
3. 项目3
* 项目1
* 项目2
3 其它
图片
![图片名称](mage.png)
链接
[链接名称]()
引用
> 第一行引用文字
> 第二行引用文字
水平线
***
代码
`
代码块高亮
```ruby
def add(a, b)
return a + b
end
```
表格
表头 | 表头
------------- | -------------
单元格内容 | 单元格内容
单元格内容l | 单元格内容
如果直接记语法,那似乎困难了些。这里OneCoder推荐两个Markdown的编辑器。
我要举报
如以上回答内容为低俗、色情、不良、暴力、侵权、涉及违法等信息,可以点下面链接进行举报!
点此我要举报以上问答信息
大家都在看
推荐资讯