一、什么是Github？

Github是通过Git进行版本控制的软件源代码托管服务平台。

Github除了Git代码仓库托管及基本的Web管理界面以外，它还提供了一些方便社会化共同软件开发的功能，即一般人口中的社群功能，包括允许用户追踪其他用户、组织、软件库的动态，对软件代码的改动和bug提出评论等。

作为一个优秀的学习者，我们摆脱不掉Github ，更为重要的是，我们不仅要学习使用别人的代码，更要向这个美好的网站贡献我们的开源精神，那么，我们如何更好的写一份项目文档呢？

二、写好项目文档

1、学会Markdown语法

Markdown基础语法

2、学会使用Emoji表情

People

:bowtie: :bowtie:

如何写一个好的Github项目文档相关推荐

如何写一个优秀的GitHub项目README文档？
今天给大家介绍一个Github上的README文档写作教程模版,该模版目前获得6634颗星星,2296Fork,相对而言,还是比较得到大家认可的.不花哨,不别出心裁,一个比较实用的,普适性的架子:所谓 ...
Github项目文档的管理
1. 用github账号注册readthedocs readthedocs 官网 2. 安装Sphinx包 (1) pip install sphinx (2)准备文档 cd /path/to/pro ...
github创建项目_用了 GitHub 上这款开源神器后，创建项目文档变得 so easy！
大家好,我是小 G. 今天跟大家分享一个可用于快速创建项目文档的开源神器:MkDocs. https://github.com/mkdocs/mkdocs 该项目创建自 2014 年,目前 GitHu ...
秒建炫酷的开源项目文档，这款神器用起来够优雅
学习过我的开源项目mall的朋友应该知道,我有一个使用Docsify 搭建的项目文档网站.使用Docsify搭建文档网站虽然简单,但是缺少分类.标签.SEO这类功能,随着文档越来越多,查找起来有点不方 ...
项目文档与毕业论文排版
版权归属: https://blog.csdn.net/halchan chanhal@outlook.com 更多关注: https://github.com/chanhal https://www ...
如何写高大上的 godoc（Go 文档）
godoc 命令和 golang 代码文档管理 https://www.jianshu.com/p/b9ce0cbaabd5 介绍 godoc 是 golang 自带的文档查看器,更多的提供部署服务 ...
showDoc项目文档管理工具
ShowDoc是什么每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却 ...
README 规范和项目文档规范
1. README 规范我们直接通过一个 README 模板,来看一下 README 规范中的内容: # 项目名称## 功能特性<!-- 描 ...
SAP项目文档　清单　考核标准
SAP项目文档的考核标准项目启动阶段项目计划及对计划的调整建议: 1. 对项目进度进行分类,定义每个阶段的关键任务. 2. 对每个阶段应形成的文档进行说明,哪类文档由谁制作,由谁签核必须做出统一 ...

如何写一个好的Github项目文档