1.基本概念
- Repository
仓库的意思,即你的项目,你想在 GitHub 上开源一个项目,那就必须要新建一个 Repository ,如果你开源的项目多了,你就拥有了多个 Repositories 。
- Issue
问题的意思,举个例子,就是你开源了一个项目,别人发现你的项目中有bug,或者哪些地方做的不够好,他就可以给你提个 Issue ,即问题,提的问题多了,也就是 Issues ,然后你看到了这些问题就可以去逐个修复,修复ok了就可以一个个的 Close 掉。
- Star
这个好理解,就是给项目点赞,但是在 GitHub 上的点赞远比微博、知乎点赞难的多,如果你有一个项目获得100个star都算很不容易了!
- Fork
这个不好翻译,如果实在要翻译我把他翻译成分叉,什么意思呢?你开源了一个项目,别人想在你这个项目的基础上做些改进,然后应用到自己的项目中,这个时候他就可以 Fork 你的项目,这个时候他的 GitHub 主页上就多了一个项目,只不过这个项目是基于你的项目基础(本质上是在原有项目的基础上新建了一个分支,分支的概念后面会在讲解Git的时候说到),他就可以随心所欲的去改进,但是丝毫不会影响原有项目的代码与结构。
- Pull Request
发起请求,这个其实是基于 Fork 的,还是上面那个例子,如果别人在你基础上做了改进,后来觉得改进的很不错,应该要把这些改进让更多的人收益,于是就想把自己的改进合并到原有项目里,这个时候他就可以发起一个 Pull Request(简称PR) ,原有项目创建人就可以收到这个请求,这个时候他会仔细review你的代码,并且测试觉得OK了,就会接受你的PR,这个时候你做的改进原有项目就会拥有了。
- Watch
这个也好理解就是观察,如果你 Watch 了某个项目,那么以后只要这个项目有任何更新,你都会第一时间收到关于这个项目的通知提醒。
- Gist
有些时候你没有项目可以开源,只是单纯的想分享一些代码片段,那这个时候 Gist 就派上用场了!
2.关于 README.md
这里写你的项目的介绍,GitHub 上所有关于项目的详细介绍以及 Wiki 都是基于 Markdown 的,甚至之后在 GitHub 上搭建博客,写博客也是如此,下面简单介绍一下Markdown的基本语法及特点。
2.1.在文本前面加上#号设置标题,并需要一个空格。
如: # 项目介绍
还可以通过增加#号的数量来表示二级标题、三级标题,#号数量越多,字号越小。
2.2.列表:在文字前面加上符号 - 就可以了,是一条短横线
2.3.插入链接:[显示文本](链接地址)
插入图片链接:![ ](图片链接地址)
3.3.引用:在你希望引用的文字前面加上 >
就好了,但需要加上空格,引用是一种显示格式
3.4.粗体和斜体:用两个 *
包含一段文本就是粗体的语法,用一个 *
包含一段文本就是斜体的语法
3.5.代码引用:如果引用的语句只有一段,不分行,可以用 ` 将语句包起来。如果引用的语句为多行,可以将```置于这段代 码的首行和末行。其中 ` 为英文输入小黄太下的 ~ 字符所在键
3.6.表格,有点复杂。。
相关代码:
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
显示效果
Tables | Are | Cool |
---|---|---|
col 3 is | right-aligned | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
另一种方式
dog | bird | cat
----|------|----
foo | foo | foo
bar | bar | bar
baz | baz | baz
显示效果:
dog | bird | cat |
---|---|---|
foo | foo | foo |
bar | bar | bar |
baz | baz | baz |