万物之时

Gmeek Blog One-Click Setup Tutorial#

type: article
status: published
date: 2024/10/20
slug: 2
summary: Gmeek provides a simple, quick, and efficient solution for creating and managing personal blogs. By leveraging the powerful features of GitHub, users don't have to worry about complex deployment processes and can focus solely on content creation. If you are looking for a lightweight and easy-to-maintain blog framework, Gmeek is undoubtedly a choice worth trying.
tags: GitHub, blog, website building
category: tutorial

Project Address https://github.com/Meekdai/Gmeek#

Gmeek Setup Tutorial#

Gmeek is an ultra-lightweight personal blog framework built entirely on GitHub Pages, GitHub Issues, and GitHub Actions. No local deployment is required; it only takes 18 seconds and two steps to set up, and you can start writing in the third step.

Introduction#

Gmeek aims to provide a simple and efficient solution for personal blogs. With the powerful features of GitHub, you don't have to worry about server configuration and maintenance; you can complete the setup and management of your blog in just a few simple steps. Gmeek utilizes GitHub Pages for static page hosting, GitHub Issues as the platform for creating blog posts, and GitHub Actions for automating the deployment process, making the entire process automated and seamless.

Features#

• GitHub-sourced UI interface: Uses GitHub's native CSS (primer.style), seamlessly integrating the interface style with GitHub.
• Automated deployment: After completing blog writing in Issues, GitHub Actions is automatically triggered to execute deployment tasks.
• Comment system: Integrates utteranc.es as the comment system, lightweight and easy to use.
• Customizable themes: Uses Jinja2 to render HTML, supporting UI theme customization through templates.
• No local deployment required: All operations are completed on GitHub, simplifying the deployment process.

Examples#

• Official Demo Page
• My created blog

The Time of All Things

Quick Start#

By following the steps below, you can complete the setup of the Gmeek blog in two steps, 18 seconds.

1. Create a Repository#

1. Create a repository from a template:

   • Click Create a repository from a template

2. Name the repository:

   • It is recommended to name the repository YOUR_GITHUB_USERNAME.github.io, where YOUR_GITHUB_USERNAME is your GitHub username.
   • Example: If your GitHub username is wanwuzhishi, then the repository name should be wanwuzhishi.github.io.

   

3. Complete the repository creation:

   • Click Create repository to finish creating the repository.

2. Enable GitHub Pages#

1. Go to repository settings:
   • On the newly created repository page, click the Settings tab at the top.
2. Configure Pages:
   • In the left menu, find and click Pages.
   • In the Build and deployment section, set Source to GitHub Actions.
3. Save settings:
   • After confirming the settings, the page will automatically save and display the deployment status.

3. Start Writing#

1. Create an Issue article:
   • Go to the repository's Issues page and click New issue to create a new article.
2. Add labels:
   • When creating the Issue, add at least one Label, such as blog.
3. Save the Issue:
   • After completing the content writing, click Submit new issue to submit.
4. Automatically generate blog content:
   • After submitting the Issue, GitHub Actions will automatically trigger the build process.
   • After a moment, your blog content will be generated and deployed to https://YOUR_GITHUB_USERNAME.github.io.
5. Check build progress:
   • You can go to the Actions page to view detailed progress and logs of the build.

4. Manual Global Generation#

In the following cases, you need to manually trigger a global generation of blog content:

• Modified the config.json file.
• Encountered strange issues during building or displaying.

Steps to operate:

1. Go to the Actions page:
   • On the repository page, click the Actions tab at the top.
2. Find the Build Gmeek workflow:
   • In the left workflow list, select build Gmeek.
3. Run the workflow:
   • Click the Run workflow button to manually trigger a global regeneration.

Submitting Issues#

If you encounter problems during setup or use, you can refer to the following steps to submit an issue:

1. Refer to Quick Start:
   • Check if you followed the steps correctly in the Quick Start.
2. Manual global generation:
   • Before submitting an issue, manually trigger a global generation to ensure the problem is not in the configuration file or build process.
3. Submit an Issue:
   • If the problem persists, go to the repository's Issues page and click New issue to submit your problem description.
   • Provide as much detailed information as possible, such as error logs, screenshots, etc., to facilitate quicker problem identification.
4. Assistance in resolution:
   • After submission, the project maintainers will assist in reviewing the build process to help identify and resolve the issue.

Conclusion#

Gmeek provides a simple, quick, and efficient solution for creating and managing personal blogs. By leveraging the powerful features of GitHub, users don't have to worry about complex deployment processes and can focus solely on content creation. If you are looking for a lightweight and easy-to-maintain blog framework, Gmeek is undoubtedly a choice worth trying.