[学习github]如何高效入门Github/GitHub中的README.MD文件编写语法

github

https://github.com/geeeeeeeeek/git-recipes

github的使用

一、注册github账号。

请自行进入https://github.com进行注册。

二、安装git及一些基本设置。

1.安装git 

1. sudo apt-get install git  

2.设置github账号信息

1. git config --global user.name "your name here"  
2. git config --global user.email "your email@example.com"  

这里“your name here”输入的是你注册github的用户名，这一步是设置你提交时，默认的用户名。

类似的，“your email@example.com”是你注册github账号的邮箱，也可以用别的邮箱，不过用别的邮箱时，需要在github主页上设置里面把用的邮箱添加进去。

3.设置让credential helper 帮助我们在一定时间内在内存中保存我们的code，其中第二行为设置超时的时间

1. git config --global credential.helper cache  
2. git config --global credential.helper 'cache --timeout=3600'  

三、建立新的repository

https://github.com/new

四、针对一个新建立的repository的操作（已有项目，跳过此小节，直接看第五节）

1.先建立一个目录，该目录与你新建的repos有关

1. mkdir ~/test_project  

 

1. cd ~/test_project  
2. git init //初始化一个空的git repository  
3. touch README //README 文件用于描述该项目  

2.提交刚刚加入的README文件

1. git add README  
2. git commit -m "first commit" //-m 用于指定本次提交的描述信息  

3.提交到repository

1. git remote add origin https://github.com//username//test_project.git  

之后会要求输入用户名和密码，输入即可

提交命令是：

1. git push -u origin master  

五、已有项目

1. 先clone下来

git clone https://github.com/username/test_project.git  

2. 进入到test_project文件中，进行文件修改，删除等操作

3.提交

 

1. git add .   // .代表添加所有文件  
2. git commit -m "对文件操作的简易描述"  
3. git push -u origin master 

 

删除文件：

1、在电脑上新建一个本地仓库repository;
2、使用gitBashHere进入到repoitory中: cd d:/repository;
3、在github上复制你要修改项目的url然后下载到本地仓库： git clone xxxxxxxxx.git;
4、使用gitBashHere进入到你要删除文件的文件夹中： cd d:/aaa/bbb/cc.text;
5、使用: git rm cc.text删除即可；git rm -r src 删除文件夹;
6、运行: git status可以查看你对文件增删改的状态；
7、运行: git commit -m ‘提示信息’ 提交到本地仓库；
8、最后: git push提交到github上,提交过程中需输入你的帐号密码；
9、添加文件到github项目上步骤也一样，只需把git rm 改为 git add即可

 

GitHub中的README.MD文件编写语法

一、标题写法：
第一种方法：
1、在文本下面加上 等于号 = ，那么上方的文本就变成了大标题。等于号的个数无限制，但一定要大于0个哦。。
2、在文本下面加上 下划线 - ，那么上方的文本就变成了中标题，同样的 下划线个数无限制。
3、要想输入=号，上面有文本而不让其转化为大标题，则需要在两者之间加一个空行。
另一种方法：（推荐这种方法；注意⚠️中间需要有一个空格）
关于标题还有等级表示法，分为六个等级，显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #，二级标题有两个# ，以此类推。
例如：

# 一级标题 
## 二级标题 
### 三级标题 
#### 四级标题 
##### 五级标题 
###### 六级标题

二、编辑基本语法
1、字体格式强调
我们可以使用下面的方式给我们的文本添加强调的效果

*强调*  (示例：斜体) 
_强调_  (示例：斜体) 
**加重强调**  (示例：粗体) 
__加重强调__ (示例：粗体) 
***特别强调*** (示例：粗斜体) 
___特别强调___  (示例：粗斜体) 

2、代码

`<hello world>` 

3、代码块高亮

、、、
@Override
protected void onDestroy() {
    EventBus.getDefault().unregister(this);
    super.onDestroy();
}
、、、

4、表格 （建议在表格前空一行，否则可能影响表格无法显示）

表头  | 表头  | 表头
---- | ----- | ------ 
单元格内容  | 单元格内容 | 单元格内容
单元格内容  | 单元格内容 | 单元格内容 

5、其他引用
图片

![图片名称](https://www.baidu.com/img/bd_logo1.png) 

链接

[链接名称](https://www.baidu.com/)   

6、列表

1. 项目1 
2. 项目2 
3. 项目3 
  * 项目1 （一个*号会显示为一个黑点，注意⚠️有空格，否则直接显示为*项目1）
  * 项目2 

7、换行（建议直接在前一行后面补两个空格）
直接回车不能换行，
可以在上一行文本后面补两个空格，
这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果，不过这个行间距有点大。
8、引用

> 第一行引用文字 
> 第二行引用文字 

gitHub中readme.md编写语法

 

1.标题表示法:分为六个等级，显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #，二级标题有两个# ，以此类推。注意：#与标题名中间的空格

    # 一级标题

    ## 二级标题

    ### 三级标题

    #### 四级标题

    ##### 五级标题

    ###### 六级标题

2.换行： 在你想换行的地方加一个<br>就行.

3.强调：

    *强调* (示例：斜体)

    _强调_ (示例：斜体)

    **加重强调** (示例：粗体)

    __加重强调__ (示例：粗体)

    ***特别强调*** (示例：粗斜体)

    ___特别强调___ (示例：粗斜体)

4.代码:

```

    你的代码

```

5.圆点符(注意中间有一个空格)

*  第一条

*  第二条

*  第三条

6.缩进(行行缩进)

 

 7.部分文字的高亮

 例如：Thank `You` . Please `Call` Me `Coder`

    >宇宙
    >>太阳系
    >>>地月系
    >>>>地球

 8.链接

举个例子一目了然：

文字超链接:[百度](https://www.baidu.com)

图片超链接：
 

在README中添加图片：

1、在github上的仓库建立一个存放图片的文件夹，文件夹名字随意。如：img-folder

2、将需要在READNE.md中显示的图片，push到img-folder文件夹中。

3、然后打开github官网，进入仓库的img-folder文件夹中，打开图片

 

 

 

 

 

点击红框所示的按钮，copy地址。

4、在README.md中填入：


保存即可。

注：![Image text]这个标识不可缺少，不然就显示文字了。

 

上传本地项目

echo "# ORB_SLAM2" >> README.md

git init

git add README.md

git add .

git commit -m "first commit"

git remote add origin https://github.com/xiaopengsu/ORB_SLAM2.git

之后会要求输入用户名和密码，输入即可

提交命令是：

git push -u origin master