使用github + hexo搭建个人博客

古城微笑少年丶 2021-12-16 13:15 406阅读 0赞

### 1、前言 ###

使用github pages服务搭建博客的好处有：

*  全是静态文件，访问速度快；
 *  免费方便，不用花一分钱就可以搭建一个自由的个人博客，不需要服务器不需要后台；
 *  可以随意绑定自己的域名，不仔细看的话根本看不出来你的网站是基于github的；
 *  数据绝对安全，基于github的版本管理，想恢复到哪个历史版本都行；
 *  博客内容可以轻松打包、转移、发布到其它平台；

##### 1.1 准备工作 #####

在开始一切之前，你必须准备好下面的东西：

*  有一个github账号，没有的话去注册一个；
 *  安装了node.js、npm，并了解相关基础知识；
 *  安装了git for windows（或者其它git客户端）

### 2、搭建github博客 ###

##### 2.1 创建仓库 #####

新建一个名为`你的用户名.github.io`的仓库，比如说，如果你的github用户名是test，那么你就新建`test.github.io`的仓库（必须是你的用户名，其它名称无效），将来你的网站访问地址就是 [http://test.github.io][http_test.github.io] 了，是不是很方便？  
![5.png][]

由此可见，每一个github账户最多只能创建一个这样可以直接使用域名访问的仓库。

几个注意的地方：

*  注册的邮箱一定要验证，否则不会成功；
 *  仓库名字必须是：[username.github.io][]，其中username是你的用户名；
 *  仓库创建成功不会立即生效，需要过一段时间，大概10-30分钟，或者更久，我的等了半个小时才生效；

创建成功后，默认会在你这个仓库里生成一些示例页面，以后你的网站所有代码都是放在这个仓库里啦。

##### 2.2 绑定域名 #####

当然，你不绑定域名肯定也是可以的，就用默认的 [xxx.github.io][] 来访问，如果你想更个性一点，想拥有一个属于自己的域名，那也是OK的。

首先你要注册一个域名，国内有很多可以选择比如阿里云、腾讯云、华为云等。因为腾讯送了我一个域名还没用，今天就拿来测试一下。

绑定域名分2种情况：带www和不带www的。

域名配置最常见有2种方式，CNAME和A记录，CNAME填写域名，A记录填写IP，由于不带www方式只能采用A记录，所以必须先ping一下你的用户名.github.io的IP，然后到你的域名DNS设置页，将A记录指向你ping出来的IP，[将CNAME指向你的用户名.github.io][CNAME_.github.io]，这样可以保证无论是否添加www都可以访问，如下：  
![6.png][]

![7.png][]  
然后到你的github项目根目录新建一个名为CNAME的文件（无后缀），里面填写你的域名。  
![8.png][]  
在你绑定了新域名之后，原来的`你的用户名.github.io`并没有失效，而是会自动跳转到你的新域名。

### 3、配置SSH key ###

为什么要配置这个呢？因为你提交代码肯定要拥有你的github权限才可以，但是直接使用用户名和密码太不安全了，所以我们使用ssh key来解决本地和服务器的连接问题。

首先得在电脑上安装好git，安装好之后鼠标右击就会出现git bash，执行如下命令：

$ cd ~/. ssh #检查本机已存在的ssh密钥

如果提示：No such file or directory 说明你是第一次使用git。

ssh-keygen -t rsa -C "邮件地址"

然后连续3次回车，最终会生成一个文件在用户目录下，打开用户目录，找到.ssh\\id\_rsa.pub文件（注意别找错了文件），记事本打开并复制里面的内容，打开你的github主页，进入个人设置 -> SSH and GPG keys -> New SSH key：  
![9.png][]

将刚复制的内容粘贴到key那里，title随便填，保存。

##### 3.1 测试是否成功 #####

$ ssh -T git@github.com

![10.png][]

看到这个信息说明SSH已配置成功！

此时你还需要配置：

$ git config --global user.name "stronglxp"// 你的github用户名，非昵称
    $ git config --global user.email  "xxx@qq.com"// 填写你的github注册邮箱

### 4、使用Hexo写博客 ###

##### 4.1 Hexo简介 #####

Hexo是一个简单、快速、强大的基于 Github Pages 的博客发布工具，支持Markdown格式，有众多优秀插件和主题。

官网： [http://hexo.io][http_hexo.io]  
github: [https://github.com/hexojs/hexo][https_github.com_hexojs_hexo]

##### 4.2 原理 #####

由于github pages存放的都是静态文件，博客存放的不只是文章内容，还有文章列表、分类、标签、翻页等动态内容，假如每次写完一篇文章都要手动更新博文目录和相关链接信息，相信谁都会疯掉，所以hexo所做的就是将这些md文件都放在本地，每次写完文章后调用写好的命令来批量完成相关页面的生成，然后再将有改动的页面提交到github。

##### 4.3 注意事项 #####

安装之前先来说几个注意事项：

*  很多命令既可以用Windows的cmd来完成，也可以使用git bash来完成，但是部分命令会有一些问题，为避免不必要的问题，建议全部使用git bash来执行；
 *  hexo不同版本差别比较大，网上很多文章的配置信息都是基于2.x的，所以注意不要被误导；
 *  hexo有2种\_config.yml文件，一个是根目录下的全局的\_config.yml，一个是各个theme下的；

##### 4.4 安装 #####

$ npm install -g hexo

##### 4.5 初始化 #####

在电脑的某个地方新建一个名为hexo的文件夹（名字可以随便取），比如我的是F:\\Workspaces\\hexo，由于这个文件夹将来就作为你存放代码的地方，所以最好不要随便放。

$ cd /f/Workspaces/hexo/
    $ hexo init

hexo会自动下载一些文件到这个目录，包括node\_modules，目录结构如下图：  
![11.png][]

$ hexo g # 生成
    $ hexo s # 启动服务

执行以上命令之后，hexo就会在public文件夹生成相关html文件，这些文件将来都是要提交到github去的。

`hexo s`是开启本地预览服务，打开浏览器访问 [http://localhost:4000][http_localhost_4000] 即可看到内容。

第一次初始化的时候hexo已经帮我们写了一篇名为 Hello World 的文章，默认的主题比较丑，打开时就是这个样子：

![12.png][]

##### 4.6 修改主题 #####

既然默认主题很丑，那我们别的不做，首先来替换一个好看点的主题。可以去主题官方网站下载。

$ cd /f/Workspaces/hexo/
    $ git clone https://github.com/litten/hexo-theme-yilia.git themes/yilia

下载后的主题都在thems文件夹下。

修改\_config.yml中的theme: landscape改为theme: yilia，然后重新执行hexo g来重新生成。

如果出现一些莫名其妙的问题，可以先执行hexo clean来清理一下public的内容，然后再来重新生成和发布。  
![13.png][]

##### 4.7 上传之前 #####

在上传代码到github之前，一定要记得先把你以前所有代码下载下来（虽然github有版本管理，但备份一下总是好的），因为从hexo提交代码时会把你以前的所有代码都删掉。

##### 4.8 上传到github #####

如果你一切都配置好了，发布上传很容易，一句hexo d就搞定，当然关键还是你要把所有东西配置好。

首先，ssh key肯定要配置好。

其次，配置\_config.yml中有关deploy的部分：

正确写法：

deploy:
      type: git
      repository: git@github.com:stronglxp/stronglxp.github.io.git
      branch: master

错误写法：

deploy:
      type: github
      repository: https://github.com/stronglxp/stronglxp.github.io.git
      branch: master

后面一种写法是hexo2.x的写法，现在已经不行了，无论是哪种写法，此时直接执行hexo d的话一般会报如下错误：

Deployer not found: github 或者 Deployer not found: git

原因是还需要安装一个插件：

npm install hexo-deployer-git --save

其它命令不确定，部署这个命令一定要用git bash，否则会提示Permission denied (publickey).

打开你的git bash，输入hexo d就会将本次有改动的代码全部提交，没有改动的不会：  
![14.png][]

##### 4.9 保留CNAME、README.md等文件 #####

提交之后网页上一看，发现以前其它代码都没了，此时不要慌，一些非md文件可以把他们放到source文件夹下，这里的所有文件都会原样复制（除了md文件）到public目录的：  
![15.png][]  
由于hexo默认会把所有md文件都转换成html，[包括README.md][README.md]，所以需要每次生成之后、上传之前，手动将README.md复制到public目录，并删除README.html。

##### 4.10 常用hexo命令 #####

常见命令

hexo new "postName" #新建文章
    hexo new page "pageName" #新建页面
    hexo generate #生成静态页面至public目录
    hexo server #开启预览访问端口（默认端口4000，'ctrl + c'关闭server）
    hexo deploy #部署到GitHub
    hexo help  # 查看帮助
    hexo version  #查看Hexo的版本

缩写：

hexo n == hexo new
    hexo g == hexo generate
    hexo s == hexo server
    hexo d == hexo deploy

组合命令：

hexo s -g #生成并本地预览
    hexo d -g #生成并上传

##### 4.11 \_config.yml #####

这里面都是一些全局配置，每个参数的意思都比较简单明了，所以就不作详细介绍了。

需要特别注意的地方是，**冒号后面必须有一个空格**，否则可能会出问题。

##### 4.12 写博客 #####

定位到我们的hexo根目录，执行命令：

hexo new 'my-first-blog'

hexo会帮我们在`_posts`下生成相关md文件：  
![16.png][]

我们只需要打开这个文件就可以开始写博客了，默认生成如下内容：  
![17.png][]  
当然你也可以直接自己新建md文件，用这个命令的好处是帮我们自动生成了时间。

一般完整格式如下：

---
    title: postName #文章页面上的显示名称，一般是中文
    date: 2013-12-02 15:30:16 #文章生成时间，一般不改，当然也可以任意修改
    categories: 默认分类 #分类
    tags: [tag1,tag2,tag3] #文章标签，可空，多标签请用格式，注意:后面有个空格
    description: 附加一段文章摘要，字数最好在140字以内，会出现在meta的description里面
    ---
    
    以下是正文

那么hexo new page 'postName’命令和hexo new 'postName’有什么区别呢？

hexo new page "my-second-blog"

生成如下：  
![18.png][]

最终部署时生成：hexo\\public\\my-second-blog\\index.html，但是它不会作为文章出现在博文目录。

##### 4.12.1 如何让博文列表不显示全部内容 #####

默认情况下，生成的博文目录会显示全部的文章内容，如何设置文章摘要的长度呢？

答案是在合适的位置加上 即可，例如：

# 前言
    
    使用github pages服务搭建博客的好处有：
    
    1. 全是静态文件，访问速度快；
    2. 免费方便，不用花一分钱就可以搭建一个自由的个人博客，不需要服务器不需要后台；
    3. 可以随意绑定自己的域名，不仔细看的话根本看不出来你的网站是基于github的；
    
    
    
    4. 数据绝对安全，基于github的版本管理，想恢复到哪个历史版本都行；
    5. 博客内容可以轻松打包、转移、发布到其它平台；
    6. 等等；

hexo g
    hexo s
    hexo d

部署上去后访问，效果如下  
![19.png][]

### 关注微信公众号【秃头哥编程】，获取更多资源 ###

![qrcode\_for\_gh\_85623aa2f946\_258.jpg][qrcode_for_gh_85623aa2f946_258.jpg]

[http_test.github.io]: http://test.github.io/
[5.png]: /images/20211214/1ffdcce8b5f149249d5114a1ac6cdd2c.png
[username.github.io]: http://username.github.io
[xxx.github.io]: http://xxx.github.io
[CNAME_.github.io]: http://xn--CNAME-w52hj3z4a144pctok8bj16giyd.github.io
[6.png]: /images/20211214/14b308cece5045089aae960d67ada8df.png
[7.png]: /images/20211214/bc963101762c478da2026ba09118e908.png
[8.png]: /images/20211214/bfbd23bb56bf4e50812b731f0586604c.png
[9.png]: /images/20211214/1f95dab636d5489496b40a1461ccb7e9.png
[10.png]: /images/20211214/9e3d7be25f0d49ca95e12b3c046a737a.png
[http_hexo.io]: http://hexo.io/
[https_github.com_hexojs_hexo]: https://github.com/hexojs/hexo
[11.png]: /images/20211214/514bd976f9e743058895c0c7ae0a0bc3.png
[http_localhost_4000]: http://localhost:4000/
[12.png]: /images/20211214/dc2cb6598a6b41e58e969a312145dfb5.png
[13.png]: /images/20211214/7c456e6ddced43e79fee1fb87599c69b.png
[14.png]: /images/20211214/cd27d5a0030a4695a881bee56dcf0205.png
[15.png]: /images/20211214/a1f1d83303e24f76ac96f622f6138630.png
[README.md]: http://xn--README-9y4js46h.md
[16.png]: /images/20211214/1b3b4f17ffb846c28d3e39b5e70c660f.png
[17.png]: /images/20211214/a8557a66cc424d6ca576b5eef3349343.png
[18.png]: /images/20211214/52c75d31b2b446f8ae1216ebeaba726f.png
[19.png]: /images/20211214/637827f88fdc4bf893b5a2eb84f29c58.png
[qrcode_for_gh_85623aa2f946_258.jpg]: /images/20211214/df08a44c41ce4656832aaa5a516848d5.png