利用pelican和gitcafe搭建博客

发表于 更新于 Disqus：

##介绍
pelican是基于python的静态web站点生成器，由python编写
目前最火热的静态站点利器jekyll则由ruby编写，出于对python的爱，我于是选择用pelican

  • 文档详见pelican，本文基于pelican 3.5.0版本
  • 源码
  • 特性：
    • 支持markdown，html和rst
    • 支持各种主题theme
    • 支持插件
    • 代码高亮

##gitcafe pages
gitcafe pages是类似于github pages的服务，不过国内访问速度更良心

###WHY gitcafe
github大法好，不过国内的访问速度令人蛋碎，当然，如果是海外党，可能恰好相反，不过如果有米，当然最好能够买一个域名，然后通过CNAME将国外和国内IP分别引导到github pages和gitcafe pages，具体做法可以参见该文

##QuickStart

  1. 在centos 7下，首先安装python，pip，virtualenv（可选,virtualenv可以将各种库，插件和主题打包到一起，比较方便）

     yum install -y python python-devel python-libs python-pip

  2. 随后安装pelican和markdown库，如果需要建立虚拟环境(virtualenv)，则可以参见该文

     pip install pelican markdown

  3. 建立一个存放博客的目录，并进入目录，取名’waaagh’（绿皮万岁)

     mkdir -p waaagh
 cd waaagh

  4. QuickStart，运行：
    pelican-quickstart，根据提示，可以快速生成一个静态页面的生产环境，例如:（输入不支持backspace键，不过输入错误可以在随后生成的pelicanconf.py文件中修改，直接按回车则是取默认值）

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
31
32
(blog)[root@localhost waaagh]# pelican-quickstart 
Welcome to pelican-quickstart v3.5.0.
        
This script will help you create a new Pelican-based website.
        
Please answer the following questions so this script can generate the files
needed by Pelican.
        
            
> Where do you want to create your new web site? [.] .
> What will be the title of this web site? waaagh!!!
> Who will be the author of this web site? lichaoran
> What will be the default language of this web site? [en] zh
> Do you want to specify a URL prefix? e.g., http://example.com   (Y/n) yes
> Do you want to specify a URL prefix? e.g., http://example.com   (Y/n) yes
> What is your URL prefix? (see above example; no trailing slash) pkking
> Do you want to enable article pagination? (Y/n) y
  How many articles per page do you want? [10] 
▽ Do you want to generate a Fabfile/Makefile to automate generation and publishing? (Y/n) y
> Do you want an auto-reload & simpleHTTP script to assist with theme and site development? (Y/n) y
> Do you want to upload your website using FTP? (y/N) n
> Do you want to upload your website using SSH? (y/N) y
> What is the hostname of your SSH server? [localhost] 
> What is the port of your SSH server? [22] 
> What is your username on that server? [root] pkking
> Where do you want to put your web site on that server? [/var/www] 
> Do you want to upload your website using Dropbox? (y/N) n
> Do you want to upload your website using S3? (y/N) n
> Do you want to upload your website using Rackspace Cloud Files? (y/N) n
> Do you want to upload your website using GitHub Pages? (y/N) y
> Is this your personal page (username.github.io)? (y/N) 
  Done. Your new project is available at /root/blog/blog

完成后，目录结构如下：

 yourproject/
├── content
│   └── (pages)
├── output
├── develop_server.sh
├── fabfile.py
├── Makefile
├── pelicanconf.py       # Main settings file
└── publishconf.py       # Settings to use when ready to publish

##push一篇博文
通常，我们将content目录作为存放文章源文件的目录，pelican支持rst，markdown和html文件。
不管3721，先撸一篇markdown文章吧：

1
2
3
4
5
6
7
8
9
Title: 我的第一发博客
Date: 2015-01-01 
Category: Python
Tags: pelican, publishing
Slug: 第一篇博客
Authors: lichaoran
Summary: Hello World

hello world!

接下来，解释一下上面的文件内容：

  • 以:隔开的key-value键值对可以成为元素局（metadata），他们构成了一些文章的基础属性，例如日期，标题，摘要等，具体的元数据可以参看pelican文档
  • 正文和metadata以空行隔开

写好文章后，将其命名为hello_world.md（.md为markdown源文件的后缀名），然后在project根目录运行pelican /path/to/your/content/ [-s path/to/your/settings.py]，其中，/path/to/your/content即是存放文章源文件的目录，刚才我们使用了content目录，该目录的名称可以在pelicanconf.py中配置，甚至，输出目录output都可以用其他配置文件代替，配置文件pelicanconf.py也可以是其他的配置文件，只需要指定path/to/your/settings.py即可。

TIPS:
写好文章后，利用刚才的命令，就已经生成好页面到output目录了，这时可以利用make serve命令启动一个本地服务器，通过访问localhost.com:8000来访问生成的页面

##主题
pelican支持各种主题，这里有各种主题及其下载链接，主题的安装和配置可以使用pelican-theme工具，具体方法参见pelican-theme --help

##配置pelican
配置文件pelicanconf.py包括了众多选项，可以参见该页进行配置

##git端的配置
在生成好第一篇文章后，可以进入到output目录，这里的内容就是即将托管到gitcafe pages的静态页面，首先，到gitcafe.com建立一个user pages或者project pages，方法参见官方帮助文档，简化下来的步骤就是：

  1. 在gitcafe.com中建立一个和用户名相同的repo
  2. 根据刚建立的空repo首页，将git username和email配置为相应的数据（在github中，非验证邮箱和用户名会导致pages build failure，不知道gitcafe是否有一样的机制）
  3. 在output目录，依次运行
1
2
3
4
5
6
git init #初始化仓库
git checkout -b gitcafe-pages #建立制定分支，pages只会渲染该分支中的页面
git add -A #添加修改
git commit -m"init the blog" #提交
git remote add gitcafe git@gitcafe.com:pkking/pkking.git #pkking替换为你的gitcafe用户名
git push gitcafe gitcafe-pages #将提交push到gitcafe
  1. OK，一切就绪，访问pkking.gitcafe.io查看渲染好的页面吧