Pelican 使用记录
1. Why Here?
之前博客搭在 Baidu Hi 上面,前后也用了好长时间了。直到最近,Baidu Hi 要下线了。。
所以把原有的内容整理了一下,准备放到 GitHub Pages 上面。
2. Why Pelican?
经过比较,决定选择基于 Pelican 生成静态页面的方式。
目前的使用里,基本只关心内容;至于页面格式,可以使用工具来完成。Pelican 就是这样的工具:
Pelican is a static site generator, written in Python, that requires no database or server-side logic.
这是 Pelican 项目的 one-sentence 介绍。详细的文档地址是 http://docs.getpelican.com/en/latest/。
除了本身是用 Python 开发的,Pelican 使用过程中的一些配置文件也是用 Python 来完成,这点非常实用。
3. Use Pelican
3.1. Install
使用万能的 easy_install
安装即可:
easy_install pelican easy_install Markdown
3.2. Kickstart your site
pelican-quickstart
这是一个向导程序,跟着提示逐步地填写,即可生成一份配置文件 pelicanconf.py
。配置文件也可以手动修改,逐步完善。
3.3. Config file
基本的配置文件 pelicanconf.py
已经可以满足使用,以下只是一些小的修改:
3.3.1. Theme
# https://github.com/cctags/pelican-octopress-theme THEME = HOME + r"/src/reference/pelican-octopress-theme" DISPLAY_CATEGORIES_ON_MENU = True MENUITEMS_AFTER = (('Archive', '/archives.html'), )
3.3.2. Plugin
PLUGIN_PATHS = ["plugins", HOME + r"/src/reference"] PLUGINS = ["cjk-auto-spacing"] #https://github.com/yuex/cjk-auto-spacing
3.4. Add a note
使用 YYYYmmdd.xxx
的格式来命名内容文件是比较直观的,且符合 Pelican 的文件排序约定。
内容文件需要放置在 content 目录下。对于特殊的内容文件,则是 content/pages 目录下。
内容文件本身是文本的,可以使用版本管理。
3.5. Compile
使用 pelican
命令编译。
4. Publish
把生成的静态页面提交到 GitHub Pages 即可。