Gmeek/README.md
2023-07-29 13:02:59 +08:00

1.5 KiB
Raw Blame History

简体中文 | English

Gmeek

一个博客框架,完全基于Github PageGithub IssuesGithub Actions。不需要本地部署,从搭建到写作,只需要几分钟的时间。

特性

  • UI界面和Github同源只引入了Github原生CSSprimer.style
  • 博客写作在Issues中完成后自动触发Actions执行部署任务
  • 评论系统引入utteranc.es

安装

  1. 克隆本仓库到自己的XXX.github.io的仓库
  2. 在仓库中配置自己的秘钥secrets.meblog有读写权限等,关键字定义在Geek.yml中可改
  3. 修改Geek.yml文件中的GITHUB_NAMEGITHUB_EMAIL
  4. 在仓库配置中设置github page的相关参数,网站根目录需要指定到docs/,需要配置个人域名的也在这里配置
  5. 配置config.json中的参数,如没有请留空,不能删除key
  6. 给仓库的Issues添加标签linkabout
  7. 最后打开一个Issues开始编写文章保存后即可通过https://XXX..github.io 访问

以上安装仅仅只是一个指导,其中有一些配置细节会在后续编写,如果有问题可在本仓库提交Issues 或者添加 QQ294977308

鸣谢