Gmeek/README.md
2023-12-15 22:36:00 +08:00

38 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

**简体中文** | **[English](README-en.md)**
# Gmeek
一个博客框架,超轻量级个人博客模板。完全基于`Github Pages` 、 `Github Issues``Github Actions`。不需要本地部署从搭建到写作只需要18秒2步搭建好博客第3步就是写作。
- [Demo页面](http://meekdai.github.io/)
- [更新日志](https://meekdai.github.io/post/Gmeek-geng-xin-ri-zhi.html)
![light](img/light.jpg)
### 安装
> 详情可见[Gmeek快速上手](https://blog.meekdai.com/post/Gmeek-kuai-su-shang-shou.html)
1. 点击[通过模板创建仓库](https://github.com/new?template_name=Gmeek-template&template_owner=Meekdai),建议仓库名称为`XXX.github.io`,其中`XXX`为你的github用户名。
2. 在你创建好的仓库的设置`Settings`中`Pages->Build and deployment->Source`下面选择`Github Actions`。
3. 打开一篇issue开始写作并且添加一个标签保存issue后会自动创建博客内容片刻后可通过https://XXX.github.io 访问
如果还有问题可在本仓库提交[Issues](https://github.com/Meekdai/Gmeek/issues)
### 特性
- UI界面和Github同源只引入了Github原生CSS[primer.style](https://primer.style/css)
- 博客写作在Issues中完成后自动触发Actions执行部署任务
- 评论系统引入[utteranc.es](https://utteranc.es/)
- 使用`jinja2`对html进行渲染可通过模板自定义UI主题
### 鸣谢
- [jinja2](https://jinja.palletsprojects.com/)
- [utteranc.es](https://utteranc.es/)
- [primer.style](https://primer.style/css)
- [gitblog](https://github.com/yihong0618/gitblog)
### License
请保留页面底部和console界面版权信息谢谢