【Github】为项目编写Readme.MD文件

我会带着你远行 2022-07-16 04:10 159阅读 0赞

转载自：http://www.coderli.com/write-readme-for-your-project/ ，侵删。

了解一个项目，恐怕首先都是通过其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/][https_stackedit.io]

[https_stackedit.io]: https://stackedit.io/

发表评论取消回复

表情：

评论列表（有 0 条评论，159人围观）

还没有评论，来说两句吧...

相关阅读

相关 GIthub创建项目并推送文件

　　由于本人是直接通过可视化工具上手Git的，所以第一次接触指令操作，如果描述有误希望各位能够踊跃的指出，非常感谢。废话不多说，正文开始。　　一、创建Git本地仓库并提交代

小咪咪/ 2023年09月24日 09:10/ 0 赞/ 63 阅读

相关为Github项目创建Docker镜像

　　我有一个GitHub project,(我正在使用它(我没有创建)),称为OpenRefine,我想封装在Docker镜像中,这样其他人就可以从“Docker Hub”中提

快来打我*/ 2023年09月24日 09:00/ 0 赞/ 122 阅读

相关为开发项目编写规范的README文件

README 1.README.md的重要性： 2.主要内容：其他关键信息：

た入场券/ 2022年11月06日 14:53/ 0 赞/ 527 阅读

相关从github克隆项目以及上传文件到github

一、从github克隆项目到本地 1.git下载 2.file---settings---version control---git ---path (为git.exe的路

╰半夏微凉°/ 2022年08月05日 08:54/ 0 赞/ 263 阅读

相关【Github】为项目编写Readme.MD文件

转载自：http://www.coderli.com/write-readme-for-your-project/ ，侵删。了解一个项目，恐怕首先都是通过其Readme文件

我会带着你远行/ 2022年07月16日 04:10/ 0 赞/ 160 阅读

相关 github新建、删除项目，提交、删除文件

今天的博客内容主要是日常github的使用，防止自己忘记。。。 -------------------- 第一个是新建与删除：新建，点击图中箭头： ![这里写图片描述

浅浅的花香味﹌/ 2022年07月12日 09:57/ 0 赞/ 247 阅读

相关删除GitHub项目的文件或者文件夹

小白pick删除GitHub项目的文件或者文件夹进入GitHub的项目仓库，找到文件或者文件夹所在仓库文件删除：进入要删除的文件，点击垃圾桶 ![70

╰+哭是因爲堅強的太久メ/ 2022年05月13日 12:34/ 0 赞/ 347 阅读

相关 GitHub（十一）：在 GitHub 上为你的项目写文档

Documenting your projects on GitHub 原文链接 -> [传送门][Link 1] 好的文档是任何项目成功的关键。保持文档可访问能够使人

ゝ一世哀愁。/ 2022年03月26日 10:46/ 0 赞/ 1174 阅读

相关 github上传项目文件

今天get到利用git很简单的上传项目到github的方法。妈妈再也不用担心我的代码了！转自：[https://www.cnblogs.com/cxk1995/p/5800

向右看齐/ 2022年01月26日 02:41/ 0 赞/ 324 阅读

相关本地上传项目文件到 github

本地上传项目文件到 github 1. 安装git (官方网站：https://git-scm.com/） 2. 注册github账号（网站地址：https://g

野性酷女/ 2021年07月25日 12:15/ 0 赞/ 616 阅读