使用 Github Pages 来托管 Pelican 生成的博客

关于 Github Pages

Github Pages 是 Github 提供的免费的空间来展现静态网页。

Websites for you and your projects. Hosted directly from your GitHub repository. Just edit, push, and your changes are live.

依照官方文档很容易做出一个 Github Pages 网页。使用 Github Pages 来写博客的主流方法是使用 Jekyll 来作为 SSG (Static Site Generator)。

把 Pelican 生成的博客托管在 Github Pages 上

由于历史原因使用了 Pelican 作为 SSG 并托管在 AWS 主机上。切换到 Github Pages + Jekyll 意味着更换 SSG ,这样必须把所有符合 Pelican 规则的 markdown 文件转换为符合 Jekyll 规则的 markdown 文件。于是想到了一个更偷懒的方法:直接用 Pelican 生成的静态网页放在 Github 上作为 Github Pages。最后再绑定我们自己的域名。这样就完成了迁移工作。

ghp-import 是做这个事情的最佳工具。

发布博客时,输入下面的命令即可:ghp-import -p output。这个命令做以下几件事情:

  1. 把 Pelican 生成的静态网页所在目录 output 下的所有文件写入 Git 的 gh-pages 分支
  2. -p 选项会把 gh-pages 分支上的内容 push 到 Github 上

打开 YourUserName.github.io/YourRepoName 就可以看到最新的博客内容了。比如 kamidox.github.io/blogs 就是我使用 Github Pages 的托管的博客了。

关于如何使用 Pelican 来写博客,可以参阅这篇文章

定制域名

关于 Github Pages 定制域名可以参阅官方教程。我们使用 Github 强烈推荐的子域名的形式来定制域名。

创建 CNAME

gh-pages 分支根目录提交一个 CNAME 文件,而 ghp-import 又会完全覆盖掉 gh-pages 分支。如何解决这个矛盾呢?阳光下没有新鲜事,具体可以参阅 Pelican 的 Tips。归纳起来,就是先在 content/extra 目录下新建一个叫 CNAME 的文件,其内容就是自定义域名的内容,如 blog.kamidox.com。然后在 Pelican 的配置文件 publishconf.py 下添加如下内容:

STATIC_PATHS = ['extra']
EXTRA_PATH_METADATA = {
    'extra/CNAME': {'path': 'CNAME'},   # 这是个路径映射,即会把 `content/extra/CNAME` 文件拷贝到 `output/CNAME`
    }

留意一下上面的路径映射。如果没有这个映射,则 Pelican 会把 content/extra 目录下的内容原封不动的拷贝到 output/extra 目录下。

修改 DNS 解析

添加一条 CNAME 记录,指向 username.github.io。比如,我需要把博客地址定为 blog.kamidox.com,则我添加一条 CNAME 解析为 blog 的记录,指向 kamidox.github.io。

至此,我们完成了博客迁移工作。

域名是如何解析的

域名解析时,我们实际上创建了两个 CNAME 。一个是在域名提供商那边,把 blog.kamidox.com 子域名使用 CNAME 指向了 kamidox.github.io;另外一个是在 Github Pages 里的 gh-pages 分支的根目录下有个内容为 blog.kamidox.com 的 CNAME 文件。当我们在浏览器里输入 blog.kamidox.com 时,浏览会先进行 DNS 解析,这个 DNS 解析和普通网络 DNS 解析没有区别,由于我们在域名提供商那边设置了 CNAME 跳转,所以这个 DNS 解析就跳转到 kamidox.github.io 上;接着进行第二次解析是在 Github 内部进行的,Github 会搜索用户下面所有的 Repo 的 gh-pages 分支下的 CNAME,查找和 blog.kamidox.com 匹配的条目,在本文的例子里,Github 找到了 blogs 这个 Repo 的 gh-pages ,于是最终跳转到了 kamidox.github.io/blogs 上面。这样就完成了域名绑定工作。


Post by Joey Huang under tools on 2015-08-22(Saturday) 23:52. Tags: github, pelican,

Comments

comments powered by Disqus

Powered by Pelican and Zurb Foundation. Theme by Kenton Hamaluik.