Gmeek/README-en.md
2023-07-29 22:39:43 +08:00

28 lines
1.5 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.

**[简体中文](README.md)** | **English**
# Gmeek
Gmeek is a Blog Generator based on `Github Pages` and `Github Issues` and `Github Actions`. No local deployment is required, and it only takes a few minutes from building to writing.
- [Demo](http://meekdai.github.io/)
- [Update Log](https://meekdai.github.io/post/Gmeek-geng-xin-ri-zhi.html)
### Feature
- The UI interface is of the same origin as Github, only Githubs native CSS is introduced[primer.style](https://primer.style/css)
- After blog writing is completed in Issues, Actions are automatically triggered to perform deployment tasks.
- The comment system used [utteranc.es](https://utteranc.es/)
### Installation
1. Create your own `XXX.github.io` repository, configure your own secret key `secrets.meblog` with read and write permissions, etc.
2. Create files `config.json` and `.github/workflows/Gmeek.yml` in the repository, copy the code in [link](CONIFG.md) and save them separately.
3. Delete redundant tags in Issues and create your own tags, such as `link`, `about`, `daily`, etc.
4. Open an issue and start writing. After saving the issue, the blog content will be automatically created. After a while, it can be accessed through https://XXX.github.io
The above installation is just a guide, and some configuration details will be written later. If you have any questions, please submit [Issues](https://github.com/Meekdai/Gmeek/issues) in this repository
### Thanks
- [utteranc.es](https://utteranc.es/)
- [primer.style](https://primer.style/css)
- [gitblog](https://github.com/yihong0618/gitblog)