github经验汇总

2021-08-02 fishedee 后端

0 概述

git 经验汇总

1 github pages

github可以轻松地将一个存放有markdown或者html文件的git文件夹转换为一个可浏览的网页。它会帮助我们转换markdown文件,以及做静态文件的服务器部署

代码在这里

1.1 创建仓库

我们首先创建一个仓库,名字为gitdoc

.
├── README.md
└── docs
    └── index.md

然后在git仓库中配置以上的目录树

# 0 概述

内容

index.md的简单内容

1.2 github pages配置

进入仓库以后,选择Settings,和Pages

在Source中选择,branch为main,文件夹为docs,确认后选择Save。之后我们可以进一步选择主题为Slate theme

https://xxx.github.io/gitdoc/

打开以上网址即可看到内容

1.3 markdown文件

# 0 概述

功能:

* [内容a](a.html)
* [内容b](b.html)

![](2021-08-03-12-48-25.png)

index.md的内容,注意,图片地址和相对其他网页的地址如何填写。

# 0 概述

内容a

![](2021-08-03-12-48-17.png)

a.md的内容

# 0 概述

内容b

b.md的内容

# gitdoc

这里是主页的抬头信息

仓库顶部目录的README.md的内容

.
├── README.md
└── docs
    ├── 2021-08-03-12-48-17.png
    ├── 2021-08-03-12-48-25.png
    ├── _config.yml
    ├── a.md
    ├── b.md
    └── index.md

目录树的安排,写入以上内容以后重新push到github

这个时候,我们就能看到github pages正常显示了。包括相对地址的网页跳转,以及图片的显示。注意,网页顶部的内容正是README.md的内容。

2 FAQ

2.1 src refspec master does not match any.

提示push不上去,但是拉下来是可以的

git branch -a

然后查看分支的时候没有master分支了,要改为main分支才对

git push origin main

改为推送到main分支就可以了

3 总结

相关文章