Home

Awesome

<div align="center"> <h1>vdoing-template</h1>

Auth Status GitHub Issues GitHub Pull Requests GitHub Pull Requests GitHub license HitCount website eryajf.github.io/vdoing-template

<p align="center"> 📖 Vdoing博客主题静态部署模板 📖</p> <img src="https://cdn.jsdelivr.net/gh/eryajf/tu@main/img/image_20240420_214408.gif" width="800" height="3"> </div><br>

⚗️ 功能亮点:

🦩 以下仅需简短的几步配置,就可以配置拥有一个免费的个人博客。准备好了吗,来吧!

效果展示

首页效果图:

image_20220721_113642

内部文章效果:

image_20220721_165503

如果你也想要一个这种效果的博客,请往下看,只需简单几个配置步骤,即可免费拥有。

初始配置

首先访问模板仓库:vdoing-template。点击此仓库右侧的 Use this template

image_20220721_153908

然后根据自己的实际情况,给仓库起名字:

image_20220721_154115

这里有一个注意点:仓库的名字将会是 GitHub Pages 的访问一级路由。比如上边我仓库名字定义为:lql-notes,那么配置成功之后的首页访问路径是: https://lql95.github.io/lql-notes ,如果你想让首页的访问路径是根,那么只需把仓库名字命名为:lql95.github.io

创建完成之后,自己仓库中的项目内容如下:

image_20220721_154502

然后将代码克隆到本地,使用编辑器打开:

$ git clone git@github.com:lql95/lql-notes.git

调整内容

接下来的操作就是将模板中的内容,替换成自己想要的内容,好在模板我已经精简了很多,不需要繁琐的配置,这里简单说明一下:

全局替换关键字

image_20220721_154907

这样基本上就搞定了配置内容的一大步,剩下的就是一些修改美化方面的内容了。

配置首页

首页的配置信息在 docs/index.md 这个文件当中,我们可以参照官方文档进行按需配置:点我去看文档

配置评论

模板默认内置了 vssue 的评论组件,也是基于 github 的 issue 作为评论的存储数据。

只需两步即可完成配置:

现在基本配置项都已经搞定,可以将代码提交上去,然后GitHub Actions会自动将代码部署到 gh-pages 分支。

终极配置

终极配置就是等 GitHub Actions 跑完之后,我们能看到分支当中多了一个 gh-pages 分支。

此时点击 Settings ---> Pages,进行如下配置:

image_20220721_160920

两个配置项,第一个表示选择哪个分支作为静态文件,第二个表示选择前边分支的哪个目录。

点击保存之后,静待一分钟,然后就可以访问上边提供的那个地址了。成果如下:

image_20220721_161147

如果你想配置个人自定义域名,可参考此文档:https://eryajf.github.io/HowToStartOpenSource/pages/06d15f/

如果一路配置没问题,那么文章也应该会自动加载评论功能:

image_20220721_165020

剩下的就是一些细节的优化调整,稍微打磨之后,就可以愉快地撰写你的博客了。