Travis CI 加 Hexo 自动部署 Github Pages 博客

前几日重装系统,顺便折腾了 Travis CI 来自动构建部署我的博客,然后把我的 Hexo 博客文件放到了 Github 上,实现了用 Git 来管理博客文件,并且脱离了本地环境的限制。

需要的工具: Git, npm, Travis CI, Github.

安装 Hexo

安装 hexo 需要使用到 npm (nodejs 的包管理)

推荐使用 NVM 来安装和管理 nodejs。可以到这里了解 NVM

1
npm install -g hexo-cli

配置 Hexo

创建 Hexo 站点

1
hexo init username.github.io

username 是你的 Github 用户名,当然也可以把 username.github.io 替换成你想要的任何名字

做一些必要的修改

  1. 用编辑器打开站点根目录的 _config.yml

  2. 修改下面这些项目

项目解释怎么改
title网站的标题啥都行,例如我的站点标题叫 Ne0Ng's Blog
author你的名字这个填上你的名字
language网站的语言都能看我的博客了,那就改成 zh-CN
timezone网站的时区国内的地区都填上 Asia/Shanghai
url网站的链接如果你没有域名的话,就填 username.github.io

其他的修改可以参考 Hexo 的文档

Configuration | Hexo Doc

修改站点的主题

  1. 下载主题
1
2
3
4
5
cd themes
git clone https://github.com/SukkaW/hexo-theme-suka.git suka
cd suka
npm install --production
cp -i _config.example.yml _config.yml

本文以 suka 为例

  1. 启用主题
1
2
# 回到站点的根目录
cat themes/suka/site_config.yml >> _config.yml

打开站点根目录的 _config.yml,将 theme: landscape 改为 theme: suka

改好之后,你站点的 _config.yml 大概是这样

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
# Extensions
## Plugins: https://hexo.io/plugins/
## Themes: https://hexo.io/themes/
theme: suka

# Deployment
## Docs: https://hexo.io/docs/deployment.html
deploy:
  type: ''

# Suka-theme
suka_theme:
  search:
    enable: true
    path: search.json
    field: post # Page | Post | All. Default post
  prism:
    enable: false
    line_number: true
    theme: default

将站点文件夹上传到 Github

初始化 git

由于我是在 CI 阶段从网络直接 clone 整个主题,所以我就将 themes/ 加入了 .gitignore,所以这里你还要将主题的配置文件复制到站点根目录内,之后 CI 阶段再将其放回原位置。(如果你用的主题有其他的配置文件时应该一并复制到站点根目录)

复制一份主题的配置文件

1
cp themes/suka/_config.yml  _config.theme.yml

初始化 git

1
git init 

确保 .gitignore 内有下面的内容 (如果没有这个文件的话可以自己创建)

1
2
3
4
5
6
7
8
.DS_Store
Thumbs.db
db.json
*.log
node_modules/
public/
.deploy*/
themes/

在 Github 创建 repository

新建一个 repository 命名为 username.github.io (username 是你的 Github 账户名称)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# 添加 Github 仓库到本地
git remote add origin https://github.com/username/username.github.io.git

# 新建一个名为 source 的分支
git checkout -b source

# 将所有文件添加到 git
git add .

# 添加 commit
git commit -m "initial"

# 将本地的文件推送到 Github 上的 source 分支
git push -u origin source

如果操作上没有问题你上传之后 repository 里面的文件应该差不多是这样的

1
2
3
4
5
6
7
8
.
├── _config.theme.yml
├── _config.yml
├── .gitignore
├── package.json
├── package-lock.json
├── scaffolds
└── source

配置 Travis CI

  1. Travis CI 添加到你的 Github 账户

  2. 前往 Github 的 Applications settings, 配置 Travis CI 的权限使其能够访问你的 repository

  3. 前往 Github 的 Personal Access TokensTravis CI 生成一个 Token ( 只需要 repo 这个权限(scopes) ),然后把 Token 的值记录下来

  4. 前往 Travis CI,在你的 repository 页面下点击 More Options 找到 Settings, 然后找到 Environment Variables,建立一个名(NAME)为 GH_TOKEN, 值( VALUE )为你上一步记录的 Token,最后保存(确保 DISPLAY VALUE IN BUILD LOG 保持 关闭 避免你的 Token 泄漏

  5. 在你的 Github 的项目 source 分支内新建一个名为 .travis.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
26
27
28
29
30
os: linux
language: node_js 
node_js:
  - 10  # 使用 nodejs LTS v10
branches:
  only:
    - source # 只监控 source 的 branch
before_script: ## 根据你所用的主题和自定义的不同,这里会有所不同
  - npm install -g hexo-cli # 在 CI 环境内安装 Hexo
  - mkdir themes # 由于我们没有将 themes/ 上传,所以我们需要新建一个
  - cd themes 
  - git clone https://github.com/SukkaW/hexo-theme-suka.git suka #从 Github 上拉取 Suka 主题
  - cd suka
  - npm install --production # 安装 Suka 主题的依赖
  - cd ../.. # 返回站点根目录
  - cp _config.theme.yml themes/suka/_config.yml # 将主题的配置文件放回原处    
  - npm install # 在根目录安装站点需要的依赖 
script: 
  - hexo generate # generate static files
deploy: # 根据个人情况,这里会有所不同
  provider: pages
  skip_cleanup: true # 构建完成后不清除
  token: $GH_TOKEN # 你刚刚设置的 Token
  keep_history: true # 保存历史
  fqdn: blog.ne0ng.page # 自定义域名,使用 username.github.io 可删除
  on:
    branch: source # hexo 站点源文件所在的 branch
  local_dir: public 
  target_branch: master # 存放生成站点文件的 branch,使用 username.github.io 必须是 master

  1. 当你保存之后, Travis CI 便会开始部署, 它完成之后,你就可以在你的 repo 里 master 分支查看到生成的站点文件

  2. 这时你应该就可以访问 https://username.github.io 查看你的站点了

更多操作

如果你想要让搜索引擎收录你的站点,可以看我写的另外一篇文章

为 Hexo 站点 SEO | Ne0Ng's Blog

参考资料

update site interface
加载评论