代码改变世界

搭建 github.io 博客站点

2018-07-20 14:08  Zongsoft  阅读(2231)  评论(0编辑  收藏  举报

前言

很多人都有搭建博客或知识库站点的想法,可自己买云服务器太不划算,部署管理也是个问题;基于免费又热门的 GitHub Pages 来搭建博客站点倒是省钱省力省事的好办法,于是上网一搜,满屏都是关于使用 Jekyll 来搭建站点的文章,这个 Jekyll 是基于 Ruby 开发的,上手得先装一大坨东西、各种啰嗦各种坑,看的一点欲望都没有了。

神器出现

平地一声雷,炸出了 Hexo (https://hexo.io/zh-cn) 这个神器。它只需要 NodeJS 即可,完全不依赖其他乱七八糟的玩意,安装部署超级简单,功能完善、漂亮主题也很多,妥妥的就是它了。

安装简单,并且官网上提供了很多主题可供选择。

  • 我喜欢的一款主题 (Archer)

http://firework.studio/archer-demo/
https://github.com/fi3ework/hexo-theme-archer

建站步骤

有关一般建站步骤,请参考本文后面的“参考文章”部分,在进行后续操作之前,请按照 Hexo 官网的安装指引,确保 NodeJS 和 Hexo 已经成功安装。

友情提示:在此之前请务必详读 Hexo 官网中的文档

我们的站点源码:https://github.com/Zongsoft/zongsoft.github.io,没必要把 Hexo 运行环境和使用的主题文件都保存在站点仓库中,所以需要将这些不需要的目录和文件加入到 .gitignore 文件中;站点的 Hexo 基本配置(hexo.config.yml)和相应主题配置文件(hexo.config-theme.archer)需要保留,以便下次或别人构建时将其覆盖还原为默认配置。

站点构建

在首次 clone 获取我们站点源码后,按顺序执行下列命令,__注意:__推荐在 Git Bash 中进行操作。

  1. 初始化 Hexo 站点目录:
hexo init site && cd site
  1. 安装相关插件:
npm i hexo-generator-json-content --save && npm i hexo-wordcount --save
  1. 获取 Archer 主题:
git clone https://github.com/fi3ework/hexo-theme-archer.git themes/archer
  1. 覆盖 Hexo 默认配置文件:
cp  ../hexo.config.yml _config.yml
  1. 覆盖 Archer 主题默认配置文件:
cp ../hexo.config-theme.archer.yml themes/archer/_config.yml
  1. 加入定制的页面布局:
cp ../post-footer.ejs themes/archer/layout/_partial/post-footer.ejs
  1. 安装 Hexo 站点:
npm install

文章写作

上面的构建过程稍微需要花点时间,但只要构建一次之后就不用管它了。

  • 通过 hexo new [layout] <title> 命令来创建一个文章,也可以手动把写好的文章拷贝到源目录(/docs/_posts/)中。
  • 执行 hexo generate 命令生成静态页面(/blog),生成之后,可以使用 hexo server 命令来查看实际效果。
  • 最后,执行相关 Git 命令将这些改动提交到远程仓库中。

__注意:__创建了一篇新文章后,务必要设置好文章的元信息(即标题、创建时间、所属分类、Tags等),具体定义请参考 Hexo 官网的这篇文章:https://hexo.io/zh-cn/docs/front-matter.html

__提示:__如果生成有问题,可以执行 hexo clean 命令来清空输出目录,之后再把项目所需的资源文件手动拷贝到输出目录的相应子目录中。

其他备注

  1. 修改 post.ejs (site/themes/archer/layout/) 模板,增加对 post-footer.ejs 局部模板的引用:
<main class="main post-page">
    <article class="article-entry">
        <%- page.content %>
    </article>

<%- partial('_partial/post-footer') %>
  1. 修改 post.ejs 模板中的分页指示的标签:

<div class="nextSlogan">Next Post</div>
> <a class="nextSlogan" href="<%- url_for(page.prev.path) %>">Next Post</a>> <div class="prevSlogan">Previous Post</div>> <a class="prevSlogan" href="<%- url_for(page.next.path) %>">Previous Post</a>

  1. 调整了 Archer 主题的 _post_page.scss (site/themes/archer/src/scss/_partial/) 中的部分样式:
// ========== paginator ========== //
.post-paginator {
    li {
        max-width:18rem;
    }

    .nextTitle,
    .prevTitle{
        font-size:1.2rem; //remove this line
    }
}

// ========== content ========== //
.abstract-content,
.article-entry {
    > p {
        text-indent:2em;
    }
}

参考文章

提示:

本文可能会更新,请阅读原文: https://zongsoft.github.io/blog/zh-cn/misc/github-site,以避免因内容陈旧而导致的谬误,同时亦有更好的阅读体验。


本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但必须保留本文的署名 钟峰(包含链接:http://zongsoft.github.io),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问或授权方面的协商,请致信给我 (zongsoft@qq.com)。