使用Hexo+GitHub搭建及配置个人博客

前言

现在用GitHub+各种静态博客框架来搭建博客系统已经非常常见了,如:Hexo、Jekyll、Octopress、WordPress…等。由于其博客系统维护方便、配置简单、原生支持MD语法等优点等一直深受码农们的喜爱。经过一番查找与对比,博主最终还是选择了Hexo,理由有以下:主题选择多且美、配置异常简单、编译文章速度极快等优点…好了,话不多说,咱们一探究竟。

搭建前的步骤

  1. 在GitHub上创建好Repository,name必须以username.github.io的形式来命名,否则不能成功部署
  2. 提前安装好GitNode.js(已安装的略过)
  3. 安装Hexo:安装Node.js后即可通过npm来安装Hexo:
    1
    $ npm install hexo-cli -g

初始化项目

执行以下命名创建并初始化项目,会自动帮我们下载/生成好相关模板文件,关于各文件及文件夹的意义,可参考官方文档

1
2
3
$ hexo init <folder>
$ cd <folder>
$ npm install

初始化完后,先安装hexo-deployer-git插件,因为后续我们将把代码上传至GitHub:

1
$ npm install hexo-deployer-git --save

站点基本配置

在主目录下的_config.yml中,配置以下基础信息,其中language修改为zh-Hans即可改成简体中文,对应主题文件夹中的languages文件夹下的zh-Hans.yml,自己看着来改就好了,有些主题是zh-CN.yml

1
2
3
4
5
6
7
# Site
title: codezjx's Home
subtitle:
description:
author: codezjx
language: zh-Hans
timezone:

接下来配置GitHub设置,类型设置为git,指定好repo地址,branch必须设置为master,因为GitHub Page只会从mater分支生成。(注意有坑:这里我们需要单独设置好在GitHub上使用name和email,否则将会使用global的user.name和user.email,囧~~):

1
2
3
4
5
6
deploy:
type: git
repo: https://github.com/codezjx/codezjx.github.io.git
name: codezjx
email: code.zjx@gmail.com
branch: master

题外话,这里简单说一下hexo-deployer-git插件的工作流程:当执行部署操作的时候,首先会自动初始化git仓库(位置在.deploy_git中),并关联到指定repo与branch,后续public文件夹中自动生成的页面代码将会拷贝至此目录中进行代码管理。若修改了name和email,需要删掉整个.deploy_git再重新部署才会生效。有兴趣的可以看下hexo-deployer-git的源码。

主题配置

首先当然是下载主题了,博主用得是Hexo上比较热门的Next主题,简洁大方好看嘿嘿,clone到themes目录中即可:

1
2
$ cd your-hexo-site
$ git clone https://github.com/iissnan/hexo-theme-next themes/next

修改主目录下的_config.yml,指向我们刚刚clone的主题:

1
theme: next

在对应主题目录下,同样有个_config.yml文件,可以对主题进行一些个性化的定制。例如在Next主题中,我们可以设置社交账号及其对应的icons。若对Next主题有兴趣的,可以参考官方的配置文档

1
2
3
4
5
6
7
8
9
10
11
12
social:
GitHub: https://github.com/codezjx
Twitter: https://twitter.com/codezjx
StackOverflow: https://stackoverflow.com/users/3919425
Weibo: http://weibo.com/2350975412
social_icons:
enable: true
GitHub: github
Twitter: twitter
StackOverflow: stack-overflow
Weibo: weibo

部署到GitHub上

主要用的是三部曲:

  • hexo g: 生成静态文件,在public文件夹中(hexo generate的缩写)
  • hexo s: 生成本地预览,默认情况下,访问网址为: http://localhost:4000/
  • hexo d: 部署并提交代码至GitHub中(hexo deploy缩写)

还有一个比较重要的命令:

  • hexo clean: 清除缓存文件 (db.json) 和已生成的静态文件 (public)。在某些情况(尤其是更换主题后),如果发现您对站点的更改无论如何也不生效,您可能需要运行该命令。

最后,打开我们创建好的GitHub Page页面:username.github.io,这个时候应该能看到Next主题默认的样式了。

关于分支

前面已经提到了,GitHub Page会根据master分支的内容来生成页面,并且master分支的内容也只包含public文件夹里自动生成的文件。那么我们hexo的配置、主题、Markdown源文件该存储到哪呢?这样以后重装了系统,或者切换了电脑,我们也可以愉快的写博客了。

有两种方式,可以新建一个独立的Repo来管理(感觉有点多余),或者直接新建一条分支。博主采用是新建分支的方式,直接$ git branch hexo来新建一条hexo分支,并把相关文件提交上去即可。

那么该提交什么文件呢?其实在最初执行$ hexo init <folder>的时候,hexo会自动生成一个.gitignore文件(按照hexo的本意,主目录里面的各种源文件也是得托管的),按照里面的指示排除掉相关文件即可。最终提交的应该有以下文件夹:

1
2
3
4
5
6
7
8
9
10
├── _config.yml
├── package.json
├── .gitignore
├── scaffolds
│ ├──draft.md
│ ├──page.md
│ └──post.md
├── source
│ └── _posts
└── themes

至此,博客系统已经基本搭好了,跟着hexo官网的writing章节开始愉快的写博客吧。当然,想更加个性化一点的话,可以上万网去买个域名,好吧先写到这,Have fun~