项目地址

Gmeek 搭建教程

前言

特点

• 与 GitHub 同源的 UI 界面：采用 GitHub 原生 CSS（primer.style），界面风格与 GitHub 无缝衔接。

• 自动化部署：在 Issues 中完成博客写作后，自动触发 GitHub Actions 执行部署任务。

• 评论系统：集成 utteranc.es 作为评论系统，轻量且易于使用。

• 可自定义主题：使用 Jinja2 对 HTML 进行渲染，支持通过模板自定义 UI 主题。

• 无需本地部署：所有操作均在 GitHub 上完成，简化部署流程。

示例

• 官方 Demo 页面

• 我建立的

快速上手

1. 创建仓库

1. 通过模板创建仓库：
   1. • 点击通过模板创建仓库

2. 2. 命名仓库：
      1. • 推荐将仓库命名为 YOUR_GITHUB_USERNAME.github.io，其中 YOUR_GITHUB_USERNAME 为你的 GitHub 用户名。
      2. • 示例：如果你的 GitHub 用户名为 wanwuzhishi，则仓库名称应为 wanwuzhishi.github.io 。

3. 完成仓库创建：
   1. • 点击 Create repository 完成仓库的创建。

2. 启用 GitHub Pages

1. 进入仓库设置：
   1. • 在新创建的仓库页面，点击上方的 Settings 标签。

2. 配置 Pages：
   1. • 在左侧菜单中，找到并点击 Pages 。
   2. • 在 Build and deployment 部分，设置 Source 为 GitHub Actions 。

3. 保存设置：
   1. • 确认设置后，页面会自动保存，并显示部署状态。

3. 开始写作

1. 创建 Issue 文章：
   1. • 进入仓库的 Issues 页面，点击 New issue 创建一篇新的文章。

2. 添加标签：
   1. • 在创建 Issue 时，至少添加一个 Label（标签），例如 blog 。

3. 保存 Issue：
   1. • 完成内容撰写后，点击 Submit new issue 提交。

4. 自动生成博客内容：
   1. • 提交 Issue 后，GitHub Actions 会自动触发构建流程。
   2. • 片刻后，你的博客内容将生成并部署到 https://YOUR_GITHUB_USERNAME.github.io 。

5. 查看构建进度：
   1. • 可进入 Actions 页面查看构建的详细进度和日志。

4. 手动全局生成

• 修改了 config.json 文件。

• 出现了构建或显示上的奇怪问题。

1. 进入 Actions 页面：
   1. • 在仓库页面，点击上方的 Actions 标签。

2. 找到 Build Gmeek 工作流：
   1. • 在左侧工作流列表中，选择 build Gmeek 。

3. 运行工作流：
   1. • 点击 Run workflow 按钮，手动触发一次全局重新生成。

提交问题

1. 参考快速上手：
   1. • 检查是否按照快速上手中的步骤正确操作。

2. 手动全局生成：
   1. • 在提交问题之前，先手动全局生成一次，确保问题不在配置文件或构建流程中。

3. 提交 Issue：
   1. • 如果问题依旧存在，进入仓库的 Issues 页面，点击 New issue 提交你的问题描述。
   2. • 提供尽可能详细的信息，例如错误日志、截图等，以便更快定位问题。

4. 协助解决：
   1. • 提交后，项目维护者会协助查看构建流程，帮助定位和解决问题。

总结