基于Github Issues的博客搭建

[superleeyom]

最新更新

• 前端仓库 superleeyom.github.io 增加了一个 remove_running 分支，去掉了 running_page 的链接（我的那个跑步记录的入口，有些人用不到），想要去掉这个链接的朋友用这个分支就行 --2022-02-11

前言

应朋友@凯佬的要求，特意写一篇基于 Github Issues 博客的搭建教程，整体的过程非常简单，后端参考了 @yihong0618 的 gitblog 项目，发布 issues，做数据备份，前端参考了@LoeiFy 的 Mirror 项目，用于做前端可视化界面，感谢二位大佬的开源精神，所有的服务全部免费（ps：如果你需要自定义域名，自定义域名需要自己付费购买），感谢 Github！

利用 Github Actions 做数据备份

首先需要 fork 我的项目 blog，也可以 fork @yihong0618 的 gitblog 项目，都差不多，然后修改 generate_readme.yml文件，这个文件是触发自动备份的 CI/CD 配置文件，修改如下的地方：

env:
  GITHUB_NAME: superleeyom
  GITHUB_EMAIL: [email protected]

改成你自己的 Github 用户名和邮箱，接着在你自己的这个 blog 仓库下，创建 Environment secrets环境变量 G_T：

这个G_T是 Github 的访问授权 Token，注意保密，不要泄漏，Token 的获取如下图，scope 如果不知道选啥，全部勾上：

修改 main.py 脚本，修改你自己的定制化的 README.md 的 header：

MD_HEAD = """**<p align="center">[Leeyom's Blog](https://blog.leeyom.top)</p>**
**<p align="center">用于记录一些幼稚的想法和脑残的瞬间~</p>**
## 联系方式
- Twitter：[@super_leeyom](https://twitter.com/super_leeyom)
- Telegram：[@super_leeyom](https://t.me/super_leeyom)
- Email：[[email protected]](mailto:[email protected])
- Blog：[https://blog.leeyom.top](https://blog.leeyom.top)
"""

在 issues 列表，提前建好 labels 标签，后面一旦提交了新的 issues，或者你修改了 issues，README.md 会根据你给当前 issues 所打的 labels 标签进行分类，比如我建了如下的几个 labels，其中TODO和Top，用于生成 TODO List 和置顶，比如你给这个 issues 加上了 Top 标签，那么他会出现在 README.md 置顶分类里面，这两个建议加上，剩下的按你自己的意愿加：

如果你是 fork 我的项目，建议先把 backup 文件夹下里面的 md 文件删除！因为那是我的 blog 备份文件！

有了这个项目，我们就可以通过 Github Actions，只要有 issues 发布或者修改，都会触发自动构建，备份issues生产 md 文件，然后刷新 README.md 文件。

后期你要发布文章，只需要创建一个 issues，然后打好标签，点击发布即可，剩下的都是自动化构建，不需要人为参与。

利用 Github Pages 做可视化界面

• 首先你得先创建一个 github用户名.github.io的仓库，必须是公共仓库，比如我的：superleeyom.github.io，然后你把我这个仓库 superleeyom.github.io 的文件全部拷贝到你刚创建的仓库里面，删除 Archive文件夹，这个是我以前备份的 md 文件，对你没啥用！

• 修改 docs 目录和根目录下的两个 CNAME 文件，里面的内容是你的自定义的域名，比如我的自定义域名是：blog.leeyom.top，如果没有自定义域名，默认填：github用户名.github.io。

• 修改 docs 目录下的 index.html 文件，比如我的：

  window.config = {
    organization: false,// 默认是 false，如果你的项目是属于 GitHub 组织 的，请设置为 true
    order: 'CREATED_AT',// 文章排序，以 创建时间 或者 更新时间，可选值 'UPDATED_AT'，'CREATED_AT'
    title: "Leeyom's Blog",// 博客标题
    user: 'superleeyom',// GitHub 用户名，必须
    repository: 'blog',// GitHub 项目名，指定文章内容来源 issues，必须
    authors: 'Leeyom',// 博客作者，以 ',' 分割，GitHub 用户名默认包含在内
    ignores: '',// 文章忽略的 issues ID
    hash: 'ghp_VkKID%Qnlgg$SXfIt!UmH&uCLCtHFU$XJHK^YmxvZy5sZWV5b20udG9w',// hash，必须
    perpage: 5,// 分页数量
  }

  其中关于 hash 的获取，参考：「获取 hash」

• 去阿里云或者腾讯云，申请一个新的域名，将域名解析到你自己刚创建的 github 仓库 github用户名.github.io，不需要自定义域名的可忽略这一步：

  

• 在 github用户名.github.io 仓库下，将 page 的 source 指向到 docs 目录，指定你的自定义域名即可，若没有自定义域名，Custom domain 可以不用设置：

  

• 最后改下你的 README.md，里面的内容是我自己瞎写的，换成你自己的，然后等个 5 分钟，访问你的域名，比如我的是：https://blog.leeyom.top（没有自定义域名默认的是：https://github用户名.github.io），看是否能正常访问，如果不能正常访问，请在当前 issues 下留言，我看到会回复。

总结

虽然 Github Issues 的定位就不是为博客而生的，这也注定了它有诸多不足之处，比如无法限制别人发 issue ，但是对于那些不想折腾，内容才是王道的程序员朋友来说，免费、Markdown、代码高亮、标签、评论、图床、备份、Github大厂背书，Github Issues 也不乏是个与自己和他人沟通的好地方。

参考资料

• 这个博客开源了
• Mirror中文教程

[Thomas-Lv]

提示401 这么解决

[superleeyom]

提示401 这么解决

@Thomas-Lv 这个应该是你的hash生成的有点问题，是不是域名没有填对，你的默认域名是：thomas-lv.github.io

[superleeyom]

@Thomas-Lv 确认：1、域名是否填对，2、token权限是否设置对
具体可以仔细看下：https://github.com/LoeiFy/Mirror/wiki/%E8%8E%B7%E5%8F%96-hash

[Thomas-Lv]

之前搭建running page的时候就生成了 一个永久有效的 token，这次搭建博客 需要重新生成新token吗？如果重新生成新token是否会对running page有影响？

[superleeyom]

这个token只要查询权限，开放所有的权限可能比较危险，你这样吧，你先重新生成一个token再试试，如果还是不行，你直接在Telegram上联系我吧？我的Telegram id：@super_leeyom
@Thomas-Lv

[zackzhangkai]

你好，关于你说的不足的地方，我做了增强，可以自动根据 label 来选择是否要发布成文章，目前支持 todo top publish标签。

https://github.com/zackzhangkai/zackzhangkai.github.io/blob/master/.github/workflows/generate_markdown_blog.yml

需要在yml中增加

name: Generate GitBlog README

on:
  workflow_dispatch:
  issues:
    types: [opened, edited, labeled]

  sync:
    if: ${{ github.event.label.name == 'todo' }} || ${{ github.event.label.name == 'top' }} || ${{ github.event.label.name == 'publish' }}
    name: Generate README

[superleeyom]

你好，关于你说的不足的地方，我做了增强，可以自动根据 label 来选择是否要发布成文章，目前支持 todo top publish标签。

https://github.com/zackzhangkai/zackzhangkai.github.io/blob/master/.github/workflows/generate_markdown_blog.yml

需要在yml中增加

name: Generate GitBlog README

on:
  workflow_dispatch:
  issues:
    types: [opened, edited, labeled]

  sync:
    if: ${{ github.event.label.name == 'todo' }} || ${{ github.event.label.name == 'top' }} || ${{ github.event.label.name == 'publish' }}
    name: Generate README

cool 🆒

[Salomens]

请问这个情况是怎么回事,我太菜了

[superleeyom]

index.html 里面的repository: 'blog', 这个填你的issues的仓库名称 @Salomens

[Salomens]

我改了index.html以后再次测试还是这样的错误

再次打扰了@superleeyom

[superleeyom]

@Salomens 等我我看下你的相关仓库的配置

[superleeyom]

@Salomens 你的issues仓库的github的token相关的环境变量创建了吗？也就是这个 secrets.G_T

[Salomens]

有的前辈@superleeyom

[Salomens]

刚才我又试了一下重新添加 secrets.G_T 这次正常了,打扰前辈了,你的教程很棒!

[superleeyom]

@Salomens cool！有问题随时联系我

[Salomens]

前辈我又来了😢,为什么我的mirror不能正常展示出我的blog仓库的东西呢
它是这样的

[superleeyom]

@Salomens 看这步：

[Salomens]

好了好了,感谢前辈,还是怪我没看仔细你的issues,打搅你了!

[superleeyom]

@salomen 建议使用原始的 Mirror，我那个被我魔改，加了我的跑步的链接，那个得修改源码才行

[hadwinn]

请教一下，如果要增加一个元素，应该如何操作呢？工作量大吗？

[superleeyom]

请教一下，如果要增加一个元素，应该如何操作呢？工作量大吗？

这个比较简单，你可以加我的电报 @super_leeyom 我可以指导下

[shenweiyan]

看到很多人在用 Github Issues 搭建博客，真是不錯

[zqisme]

这个mirror网站打不开了，是不是无法获取hash了

[superleeyom]

这个mirror网站打不开了，是不是无法获取hash了

怎么感觉像是你的网络有问题啊，你检查下网络是否通畅 @zqisme

[zqisme]

这个mirror网站打不开了，是不是无法获取hash了

怎么感觉像是你的网络有问题啊，你检查下网络是否通畅 @zqisme

请问你这边可以正常打开吗https://mirror.am0200.com/ ，我即使挂梯子也打不开这个网站，要不就跳转到这个。我是漏了什么吗

[QiYongchuan]

GitHub的主页推荐了我你的这个项目，嘿，咱们的后端都是一样的，我正好缺前端的东西，感谢大佬写的详细教程！

[JosieWei2023]

这个mirror网站我也打不开

[yaoqs]

欢迎大家来这里转转https://github.com/yaoqs/Issues-LordYao