今天我们要补充之前没有讲到的小知识,.gitignore 与 README 文件。

1. .gitignore 文件

首先,这次的课程,要用 IDE 来打开之前的项目,不要再使用文本编辑器了,我这里呢使用 WebStorm 做演示。

只要你一打开这个项目,你再看 GitHub 客户端,里面就出现了一大堆.idea 开头的文件。这些文件都是 WebStorm 编辑器生成的,而这些东西,跟我们的项目其实一点关系都没有啊。所以它们是不应该被提交到 Git 仓库的。除了编辑器生成的文件外,开发中非常常见的另外两种需要排除的文件是:

  • 一是,一些隐私类的文件,例如代码中加密用的秘钥、服务器信息,数据库密码等需要保密的信息。
  • 二是,第三方包文件,例如 Node 的 node_modules。Php 中 Composer 生成的 vendor 目录等等。

它们不应该提交到 Git 仓库中,正确解决的方法,就是使用.gitignore 文件了。

大家使用 WebStorm,在项目根目录上,新建一个.gitignore 文件

image.png

然后提示,是否增加到 git,Add 就好

image.png

然后在里面写上

.idea

再看 GitHub 客户端上,那些.idea 开头的文件就都消失了。

最后,可以将.gitignore 文件勾选,并且并 Push 上去。

2. README.md 文件

咱们课程开篇的时候,就新建了一个 README.md 文件,那这个名字呢,我不是随意乱取的,它在 GitHub 中是有特殊意义的。README,中文就是读我,看我的意思。这里写的内容就是整个项目的说明文件,它会放在 GitHub 仓库的首页展示。

至于后缀.md,这表明它是一个 markdown 文件。你在书写的时候,就要遵循 markdown 的格式来编写。那么现在来简单说一点 markdown 的基础知识。学习之前,可以给 WebStorm 装上 markdown 的插件,这样就能看到 markdown 格式和最终转换换出来的效果对照。

2.1. 标题

html 里面的标题,是由 h1~h6 组成的。在 markdown 里面呢,一个#,跟着一个空格,再加上内容,这就是 h1 了。两个##,那就是 h2,其他依次类推。

# 一级标题
## 二级标题

2.2. 代码段

如果你要在 markdown 里放一些代码段,方法也很简单,使用三个点号,这个点号,是在键盘左上角 esc 键的下方的那个键。然后跟着你的编程所使用的语言是什么,例如这里我写 js,当然你写全称 javascript 也是一样的。

```js
function hello(){
   console.log('Git')
}
```

markdown 就会把它翻译成代码段,而且传到 GitHub 这种平台后,还会根据你设置的语言,自动自动代码高亮。

关于 markdown 的教程,不属于咱们这次 Git 课程的内容。网上相关的教程非常多,学起来其实也很简单,大家自行看一下就好了。我们这节课就只简单的介绍一下就好了,最后把这里测试的 markdown 内容,也也 commit 并 push 上去,咱们进入下一节课程。

已添加到喜欢了