Gmeek is a Blog All in Github
背景: 1. Gmeek 使用了 GitHub API 将 markdown 渲染为 html; 2. 而在这个过程 GitHub 会使用开源项目 Camo 将 markdown 中的图片进行托管; 3. Camo 会为每幅图像生成开头为 https://camo.githubusercontent.com/ 的匿名 URL 代理; Github 这么做的理由是: 1. 代理这些图像将有助于保护用户的隐私:用户访问这些图片时,浏览器信息不会泄露给第三方服务; 2. Github 通过 CDN 加速图像的访问; 3. 有 CDN 可以减少因原始图片链接失效而无法正常渲染的情况; 然而如果你的图片本身托管在国内,GitHub 这么做反而会降低图片的访问速度,甚至导致无法访问(不能科学上网时)。 因此,增加一个单独的配置项,如果配置了 `"disableCamo": 1`,Gmeek 会在 GitHub 渲染网页后将图片链接简单替换为原始链接。 |
||
|---|---|---|
| .github/workflows | ||
| img | ||
| plugins | ||
| templates | ||
| .gitignore | ||
| Gmeek.py | ||
| LICENSE | ||
| README-en.md | ||
| README-ru.md | ||
| README.md | ||
| requirements.txt | ||
Gmeek
一个博客框架,超轻量级个人博客模板。完全基于Github Pages 、 Github Issues 和 Github Actions。不需要本地部署,从搭建到写作,只需要18秒,2步搭建好博客,第3步就是写作。
安装
-
【创建仓库】点击通过模板创建仓库,建议仓库名称为
XXX.github.io,其中XXX为你的github用户名。 -
【启用Pages】在仓库的
Settings中Pages->Build and deployment->Source下面选择Github Actions。 -
【开始写作】打开一篇issue,开始写作,并且必须添加一个
标签Label(至少添加一个),再保存issue后会自动创建博客内容,片刻后可通过https://XXX.github.io 访问(可进入Actions页面查看构建进度)。 -
【手动全局生成】这个步骤只有在修改
config.json文件或者出现奇怪问题的时候,需要执行。
通过Actions->build Gmeek->Run workflow->里面的按钮全局重新生成一次
提交问题
特性
- UI界面和Github同源,只引入了Github原生CSS:primer.style
- 博客写作在Issues中完成后,自动触发Actions执行部署任务
- 评论系统引入utteranc.es
- 使用
jinja2对html进行渲染,可通过模板自定义UI主题
赞赏
如果本项目对你有帮助,可以用微信赞赏一下作者,让项目有继续更新维护下去的动力,谢谢!
鸣谢
License
请保留页面底部和console界面版权信息,谢谢!

