其实在 github pages(以下简称 pages)上部署 hugo 的过程很简单,如何保证这些文件的迁移才是有点麻烦的事,不过最关键的问题其实在于你是否有足够的精力写下去。

初阶

需要准备的一些东西

  • github 帐号
  • hugo
  • git

开始

git 跟 hugo 这两个软件包应该在很多 Linux 发行版中都可以找到,可以直接使用系统对应的包管理进行安装即可。
安装完之后可以使用下面的命令进行确认

1
$ hugo version

然后使用下面的命令创建站点

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
$ hugo new site mysite 
Congratulations! Your new Hugo site is created in /home/xxx/demo/mysite.

Just a few more steps and you're ready to go:

1. Download a theme into the same-named folder.
   Choose a theme from https://themes.gohugo.io/ or
   create your own with the "hugo new theme <THEMENAME>" command.
2. Perhaps you want to add some content. You can add single files
   with "hugo new <SECTIONNAME>/<FILENAME>.<FORMAT>".
3. Start the built-in live server via "hugo server".

Visit https://gohugo.io/ for quickstart guide and full documentation.

输入命令后基本上立刻就可以看到输出的 “congratulation …”,这说明创建成功了。

刚创建好的站点一般包含下面几个目录

1
2
3
4
5
6
7
8
9
mysite
├── archetypes
│   └── default.md
├── config.toml
├── content
├── data
├── layouts
├── static
└── themes

注意: 如果没有指明操作路径,默认就是在 mysite 下。

接下来去 hugo 主题站 挑一个自己喜欢的主题,然后将其下载到 themes 目录中。下面以 hugo-theme-jane 为例。

1
2
$ cd mysite
$ git clone https://github.com/xianmin/hugo-theme-jane themes/jane

在 jane 目录下有一些已经比较完善的配置文件,像是 jane/exampleSite 下的 config.toml 以及 jane/archetypes/default.md,前者是用来配置站点的环境的,后者则是编写的文章的模板文件,一般这些文件里都会有比较详细的说明,根据它的说明进行修改就可以了。

修改完成之后,就可以创建一篇文章来测试一下

1
$ hugo new post/helloWorld.md

这条命令将会在 mysite/content/post 下创建 helloWorld.md 这个文件,向这个文件里随便加点内容。然后使用下面的命令来预览一下效果

1
$ hugo server -D

打开浏览器,输入 http://localhost:1313 就可以看到博客日后的样式了。

如果预览之后觉得满意,就可以使用下面的命令将站点部署至 pages(请将下面的 Name 修改为你的 github 用户名),在开始之前,先在 github 上创建一个名为 Name.github.io 的 repo

1
2
3
4
5
6
7
$ hugo
$ cd public
$ git init
$ git add .
$ git remote add origin https://github.com/Name/Name.github.io.git
$ git commit -m "create blog site"
$ git push origin master

在浏览器输入 Name.github.io 就可以查看部署好的站点。

备份

这样 hugo 站点基本就算是部署完成了,不过这些文件都是 hugo 编译好的一些静态文件,为了避免更换系统之后无法更新博客,你需要将 mysite 站点下除了 public 之外的目录都进行一个备份(之所以不备份 public 目录,是因为在执行 hugo 命令之后都会重新生成 public 目录)。

可以在 github 创建一个新的 repo 来存放这些文件。假设这个 repo 名为 Blog

1
2
3
4
5
6
$ git init
$ git submodule add https://github.com/xianmin/hugo-theme-jane.git themes/jane
$ echo "public/" >> .gitignore
$ git add .
$ git commit -m "backup blog"
$ git push origin master

上面的第二步使用 submodule 参数是因为 themes/jane 目录本身也是一个使用 git 进行版本控制的目录。而 public 虽然也是一个使用 git 进行版本控制的目录,但是因为它已经被添加到 .gitignore 文件当中,所以是不会被 git 索引的。

如果你换了系统之类的,先将 Blog 这个 repo 克隆到本地,然后再将主题克隆一遍就可以像之前那样继续你的写作了。

1
2
$ git clone https://github.com/Name/Blog.git && cd Blog
$ git clone https://github.com/xianmin/hugo-theme-jane.git themes/jane

进阶

初阶里面你需要写完文章之后手动构建一下,这种方式显然不够优雅,下面一起来康康怎么让构建的过程完全自动化。

为了这个自动化的过程,你需要将网站的源码和 public 下面的内容放在 dianbanjiu.github.io 仓库的不同分支,不过要保证主分支必须放的是 public 里面的内容。我这里的分支对应关系是 master 分支存放 public,blog 分支存放源码,其中 master 为主分支。

这个自动化的过程需要结合 github action 来完成。

首先我们先来配置一下 action。

  1. 去 dianbanjiu.github.io 仓库的 Settings->Deploy keys 添加一个新的 deploy key,这个 key 用你的 ssh 公钥即可,记得勾选 Allow write access
  2. Settings->Secrets 下添加一个新的 Secrets,这里填写你的 ssh 密钥,名字为了与之后的脚本对应就设置为 ACTIONS_DEPLOY_KEY
  3. 在源码对应的分支下根目录下创建一个 .github 的目录,在 .github 下创建一个叫做 workflows 的目录,workflows 目录下创建一个 public.yml 的文件。简单来说就是 github action 会从分支根目录下寻找 .github/workflows 目录,这个目录下存放的就是你的一些 action,如果你有多个任务可以创建多个 action,不过这里就不多说了。

public.yml 文件的内容如下

 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
name: Build and Publish Blog

on: 
  push:
    branches:
      - blog

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/[email protected]
      - name: setup hugo
        uses: peaceiris/[email protected]
        with:
            hugo-version: 'latest'
      - name: build hugo
        run: hugo --gc --minify --cleanDestinationDir
      - name: deploy hugo
        uses: peaceiris/[email protected]
        env:
          ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          PUBLISH_BRANCH: master
          PUBLISH_DIR: ./public

这里只介绍其中几个比较关键的点:

  1. branches 下指定的分支是你网站源码所在的分支,如果指定错误这个 action 就无法运行
  2. ACTIONS_DEPLOY_KEY 的值对应于你之前在 Settings->Secrets 下添加的 Secrets,确保两者一致即可
  3. PUBLISH_BRANCH 对应于你的主分支
  4. PUBLISH_DIR 对应于执行 hugo 命令后生成文件的位置,一般默认就是 ./public

做完这些之后再将内容推送到 blog 分支的时候,action 就会自动执行构建过程,然后将构建好的博客内容推送到 master 分支

延伸阅读

GitHub Actions 入门教程