• Stars
    star
    208
  • Rank 189,015 (Top 4 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 2 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Vdoing主题博客模板

vdoing-template

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

📖 Vdoing博客主题静态部署模板 📖


⚗️ 功能亮点:

  • 三步配置生成一个属于自己的免费个人博客。
  • 使用Vdoing主题,感谢作者写出如此简洁美观的博客主题。
  • 模板已内置集成全文搜索能力。
  • 模板已内置集成基于 GitHub Issue 的 vssue 评论系统。
  • 本地 Markdown 编写文档,提交到远程之后GitHub Actions自动构建发布。

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

效果展示

首页效果图:

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 [email protected]:lql95/lql-notes.git

调整内容

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

全局替换关键字

image_20220721_154907

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

配置首页

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

配置评论

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

只需两步即可完成配置:

  • 第一步:参考官方文档,创建一个GitHub OAuth App。或者不用看官方文档,直接看如下两个步骤。

    点击此处,进入创建页面:

    image_20220721_155930

    点击注册之后,就进入到了详情页面,可以看到Client ID,点击 Generate a new client secret 生成一个秘钥:

    image_20220721_160023

  • 第二步:将配置信息填写到 docs/.vuepress/config.js 中。

    // vssue 评论插件
      plugins: [
        [
          "vuepress-plugin-vssue-global",
          {
            platform: "github",
            title: "[Comment]<%- frontmatter.title %>",
            needComments: true,
            // 其他的 Vssue 配置
            autoCreateIssue: true,
            clientId: "d3ec4ca6363950ca41a2",
            clientSecret: "897465b6393f1d663e6128d2fab6959a0c0333cc",
            owner: "lql95",
            repo: "lql-notes",
          },
        ],
      ],

现在基本配置项都已经搞定,可以将代码提交上去,然后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

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

More Repositories

1

Thanks-Mirror

整理记录各个包管理器,系统镜像,以及常用软件的好用镜像,Thanks Mirror。 走过路过,如觉不错,麻烦点个赞👆🌟
2,197
star
2

chatgpt-dingtalk

🔔 钉钉 & 🤖 GPT-3.5 让你的工作效率直接起飞 🚀 私聊群聊方式、单聊串聊模式、角色扮演、图片创作 🚀
Go
1,411
star
3

go-ldap-admin

🌉 基于Go+Vue实现的openLDAP后台管理项目
Go
863
star
4

HowToStartOpenSource

⚗️ GitHub开源项目维护协作指南
858
star
5

learning-weekly

📝 周刊内容以运维技术和Go语言周边为主,辅以GitHub上优秀项目或他人优秀经验。欢迎star点赞收藏👆🌟
358
star
6

eryajf.github.io-old

二丫讲梵👇博客全部源码
302
star
7

magic-of-sysuse-scripts

🪄 运维外挂小工具
Shell
264
star
8

awesome-github-profile-readme-chinese

🦩 优秀的中文区个人主页搜集
185
star
9

go-ldap-admin-ui

🌉 基于Go+Vue实现的openLDAP后台管理项目
Vue
158
star
10

read-list

📖 优质内容订阅,阅读方为根本
151
star
11

awesome-stars-eryajf

🤩 我的star列表,每天凌晨自动更新
121
star
12

awesome-navigation

🧭 优秀的导航项目,优质的导航站搜集整理
95
star
13

care-screenshot

给我一个URL,我能将你关心的元素截图发给机器人🤖
Go
41
star
14

chatgpt-wecom

💬 基于GO语言实现的体验最好的企微应用集成ChatGPT项目 🚀
Go
36
star
15

Obsidian-Plugin-Weekly

📝 Obsidian插件周刊
Shell
25
star
16

go-ldap-admin-doc

go-ldap-admin项目官方文档
JavaScript
24
star
17

xirang

简单好用,直接上手的go-web框架
Go
20
star
18

awesome-chatgpt-answer

🙋 问得好,🗣 答得妙。那些值得记录的与ChatGPT的问答。
20
star
19

eryajf

eryajf readme profile with 15 stars and 22 forks 🌟
15
star
20

magic-of-kubernetes-scripts

使用小脚本一键部署k8s-1.10.4高可用集群,更多交流可以访问我的个人博客:www.eryajf.net
Shell
15
star
21

shellabout

一些值得长久珍藏的shell相关文件
JavaScript
14
star
22

third-tools

🧰 三方工具简单入门使用合集
Go
13
star
23

ldapctl

OpenLDAP Controller
Go
12
star
24

recommend-actions

优秀的GitHub Actions推荐
11
star
25

eryajfctl

🚀 基于Cobra库快速打造类似kubectl一样的命令行工具箱 🧰
Go
11
star
26

cloudctl

与公有云等交互的命令行工具
Go
10
star
27

docker_learn

学习docker过程中所用到的一些东东
Dockerfile
8
star
28

xirang-ui

🐉 简单好用,不缠不绕,直接上手的go-web框架
Vue
8
star
29

rpmbuild

整理工作中常用的RPM构建spec
C
7
star
30

learn-github

学习GitHub相关交互以及功能
7
star
31

eryajf-dockerfile

🏺 个人常用的Docker镜像汇总
Dockerfile
5
star
32

ldapool

Connection pooling encapsulated for go-ldap packets
Go
4
star
33

t

个人图床
4
star
34

tu

图床
4
star
35

docsify-template

docsify模板
4
star
36

vue-learn-code

vue学习笔记
JavaScript
4
star
37

wiki-eryajf

Shell
4
star
38

Learning-Weekly-old

这里记录我每周工作学习过程中遇到学到的优秀开源项目,优秀文章,以及优秀博客。
Shell
4
star
39

gitlabCodeSearch

🔎 使用关键字搜索所有gitlab项目
Go
2
star
40

langchaingo-ollama-rag

学习基于langchaingo结合ollama实现的rag应用流程
Go
1
star
41

go-alimail

🧰 阿里企业邮箱 GO 语言 SDK
Go
1
star