Hugo + Github 免费部署自己的博客

环境准备

1.1 Git下载

前往【Git官网】，下载安装程序一直点下一步，默认安装即可

Hugo下载

前往【Hugo Github Tags】，选择对应版本下载，下载后解压即可 Windows下载版本：hugo_extended_xxxxx_windows_amd64.zip

搭建博客

创建博客

（1）在hugo.exe所在文件夹的地址栏敲打cmd，然后Enter唤起命令行

（2）敲打命令hugo new site xxxx创建hugo文件

（3）敲打命名cd xxxx切换目录，并把hugo.exe复制到刚生成的文件夹中

（4）敲打命令hugo server -D启动服务，访问http://localhost:1313，Ctrl+C停止服务（hugo默认是没有主题的，需要进行主题配置）

配置主题

（1）前往【Hugo Themes】，查找自己喜欢的主题，进行下载

（2）这边以【Stack主题】为例，将下载好的主题解压，放到/themes文件夹中

（3）将exampleSite样例数据中的 Content 和 hugo.yaml 复制到主文件夹中，并删掉hugo.toml和content/post/rich-content

（4）修改 hugo.yaml 中的 theme，将他修改为跟主题文件夹同名

（5）再次启动hugo服务，查看主题，具体主题配置修改 hugo.yaml，这里不细说，感兴趣可自行查找相关文章

启用 Giscus 评论

Giscus 是利用 GitHub Discussions 实现的评论系统，开源、无跟踪、无广告、永久免费。

Hugo 对 Giscus 有很好的支持，在 hugo-theme-jane 主题中配置启用Giscus 很简单。

要启用 Giscus 请先确保：

仓库是公开的，否则访客将无法查看 discussions。 giscus app 已安装，否则访客将无法评论和回应。
Discussions 功能已在你的仓库中启用。

前面搭建的博客仓库就是公开的，满足了第一点，接下来要做的就是安装 Giscus app 和启用 Discussions。

References

https://www.codeaer.com/post/enable-giscus-comments-in-hugo/

配置 Giscus 根据版本有所不同，0.143.1版本可使用以下模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


# repoId、categoryId参考网址修改：https://giscus.app/zh-CN
giscus:
    repo: "xxx/xxx.github.io"
    repoId: "xxx"
    category: "General"
    categoryId: "xxx"
    mapping: "pathname"  # comment value is the default value
    strict: 0
    reactionsEnabled: 1
    # emitMetadata: 0
    inputPosition: "top"
    theme: "dark"
    lang: "zh-CN"
    lazyLoading: true
    crossorigin: "anonymous"

Github部署

常规部署

（1）前往【Github官网】，创建仓库 {github用户名}.github.io

（2）前往Setting -> Pages -> Branch选择main分支，然后保存，会自动开启 https://{github用户名}.github.io 的地址，这地址也是以后访问博客的地址

（3）回到hugo文件中，执行命令hugo -D，会生成 public 静态资源文件夹

（4）在 public 执行以下命令上传到github仓库上，第一次上传可能需要输入账号密码

1
2
3
4
5
6


git init
git add .
git commit -m "first commit"
git branch -M main
git remote add origin {你的github仓库地址}
git push -u origin main

（5）上传成功后访问 https://{github用户名}.github.io，成功搭建属于自己的Hugo博客

Github Action自动部署

（1）Github创建一个新的仓库，用于存放Hugo的主文件

（2）前往Setttings -> Developer Settings -> Personal access tokens，创建一个token(classic)

（3）token选择永不过期，并勾选 repo 和 workflow 选项

（4）为保证安全，将生成的token，保存的仓库的变量中，前往Settings -> Secrets and variables -> Actions中设置

（5）在hugo主文件创建一个.github/workflows/xxxx.yaml文件，将以下内容复制进去，想具体了解更多，可查看【Github Action文档】

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34


name: deploy

# 代码提交到main分支时触发github action
on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
        - name: Checkout
          uses: actions/checkout@v4
          with:
              fetch-depth: 0

        - name: Setup Hugo
          uses: peaceiris/actions-hugo@v3
          with:
              hugo-version: "latest"
              extended: true

        - name: Build Web
          run: hugo -D

        - name: Deploy Web
          uses: peaceiris/actions-gh-pages@v4
          with:
              PERSONAL_TOKEN: ${{ secrets.你的token变量名 }}
              EXTERNAL_REPOSITORY: 你的github名/你的仓库名
              PUBLISH_BRANCH: main
              PUBLISH_DIR: ./public
              commit_message: auto deploy

（6）在hugo主文件创建.gitignore文件，来避免提交不必要的文件

1
2
3
4
5
6
7


# 自动生成的文件
public
resources
.hugo_build.lock

# hugo命令
hugo.exe

（7）将hugo的主文件上传到仓库，上传成功后会触发Github Action，来自动部署你的静态页面

1
2
3
4
5
6


git init
git add .
git commit -m "first commit"
git branch -M main
git remote add origin {你的github仓库地址}
git push -u origin main

Reference

https://letere-gzj.github.io/hugo-stack/p/hugo/custom-blog/