Gmeek/README.md
2023-09-04 10:28:07 +08:00

3.1 KiB
Raw Blame History

简体中文 | English

Gmeek

一个博客框架,超轻量级个人博客模板。完全基于Github PagesGithub IssuesGithub Actions。不需要本地部署从搭建到写作只需要几分钟的时间3步搭建好博客第4步就是写作。

light

安装

  1. 创建自己的XXX.github.io的仓库,在仓库的设置中Pages->Build and deployment->Source下面选择Github Actions
  2. 在仓库中创建文件config.json.github/workflows/Gmeek.yml复制链接中的代码分别保存。
  3. 在Issues中删除多余标签创建自己的标签linkabout日常等。
  4. 打开一篇issue开始写作并且添加一个标签保存issue后会自动创建博客内容片刻后可通过https://XXX.github.io 访问

如果有问题可在本仓库提交Issues 或者添加 QQ294977308

特性

  • UI界面和Github同源只引入了Github原生CSSprimer.style
  • 博客写作在Issues中完成后自动触发Actions执行部署任务
  • 评论系统引入utteranc.es
  • 使用jinja2对html进行渲染可通过模板自定义UI主题

说明

  1. 请确保每一篇文章有且仅有一个Label为了防止他人提交的Issue也被抓取生成文章。

  2. 如果要导入以前的文章,如何设置发布时间呢?
    如需上传旧博客的文章需要修改发布时间,可以在文章最后一行添加如下代码。里面的时间是采用时间戳的形式,可以用如下网站转换。

<!-- ##{"timestamp":1490764800}## -->
  1. 自定义单篇文章页面的stylescript同样是在文章最后一行添加如下代码为JSON格式。
<!-- ##{"style":"<style>#postBody{font-size:20px}</style>"}## -->
<!-- ##{"script":"<script async src='//busuanzi.ibruce.info/busuanzi/2.3/busuanzi.pure.mini.js'></script>"}## -->
  1. 可同时一起添加多种自定义参数:
<!-- ##{"script":"<script async src='//busuanzi.ibruce.info/busuanzi/2.3/busuanzi.pure.mini.js'></script>","style":"<style>#postBody{font-size:20px}</style>","timestamp":1490764800}## -->
  1. 如果修改过config.json里面的参数后发现生成文章失败或其他奇奇怪怪的问题。
    建议通过Actions->build Gmeek->Run workflow->里面的按钮全局重新生成一次就行。

  2. 置顶博客文章,只需要Pin issue即可。

  3. 如果在评论里面登录后评论报错,可直接按照提示安装utteranc app即可

Error: utterances is not installed on aixcyi/aixcyi.github.io. If you own this repo, install the app. Read more about this change in the PR.

鸣谢

License

请保留页面底部和console界面版权信息谢谢