Pelican初体验

  • By 龙井
  • Wed 20 April 2016
  • Updated on Mon 25 April 2016

1. 介绍

Pelican是基于Python的静态页面生成工具，支持博客（Markdown、reStructuredText）、评论、主题、语法高亮等等。

Pelican是法国工程师写的，Pelican也是法语中notebook的音译。

Github地址

https://github.com/getpelican/pelican

官方文档

http://docs.getpelican.com

架构

架构示意图

图片

UML设计图

图片

2. 安装

安装pelican和markdown，markdown是我选择的文档编写工具（语言），pelican还支持reStructuredText和AsciiDoc格式

pip install pelican markdown

升级pelican 

pip install --upgrade pelican

3. 使用

3.1 过程

创建目录

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

快速创建博客站点

pelican-quickstart

创建博客文章

Title: My First Review
Date: 2010-12-03 10:20
Category: Review

Following is a review of my favorite mechanical keyboard.

生成站点

pelican content

预览站点

cd ~/projects/yoursite/output
python -m pelican.server

地址：http://localhost:8000/

3.2 编写技巧

目录结构

content/
├── blogs
├── downloads
├── images
├── pages
└── pdfs
    blogs
        文章目录
    downloads
        zip文件目录
    images
        图片目录，根据分类和文章可以再拆分
    pages
        about.MD页面路径
        存储不常变化的内容
    pdfs
        pdf文件目录

文章配置

Title: 凤凰项目
Date: 2016-04-23 19:40
Modified: 2016-04-24 19:40
Category: 读书笔记
Tags: DevOps, 读书笔记, 凤凰项目,专业书籍, 2016
Slug: phoenix-project-2016-04-23 #在url中显示的地址
Authors: 龙井  #多位作者逗号分隔
Summary: 简介  #会作为简介显示在首页中

图片

![图片](/images/booknotes/cross-boundary/cross-boudary-cover.jpg)

链接

文件
    [下载文件](/downloads/archive.zip)
URL
    [打开网页](http://192.168.33.15:8000/)

语法高亮

不显示行
    :::python
    print("The triple-colon syntax will *not* show line numbers.")

显示行
    #!python
    print("The path-less shebang syntax *will* show line numbers.")

注意：代码块一定要缩进

自定义404页面

注意

Pelican中文章按照时间排序

3.2 发布

Github Page

Github Page是Github为用户免费提供的静态站点托管平台，只要在Github中创建仓库“username.github.io”，则会在地址http://username.github.io中显示仓库的内容。

手动更新

  1. 创建仓库

    git@github.com:ijyun/ijyun.github.com.git

  2. 推送内容

    将output的内容推送到仓库中

  3. 访问地址

    http://ijyun.github.io/

自动更新

创建仓库

  1. 源文件仓库

    git@github.com:ijyun/longjing-blog.git

  2. 生成网站仓库

    git@github.com:ijyun/ijyun.github.com.git

配置Travis-CI
  1. 配置travis-ci以便自动出发构建

  2. 安装travis命令

    # on Ubuntu you need ruby dev
sudo apt-get install ruby1.9.1-dev
sudo gem install travis

  3. 生成Github的口令

    通过Travis-CI往Github做提交需要具有权限，在Github的Personal settings——Personal access tokens，生产token，权限范围只需要勾选repo即可。然后在源文件仓库根目录执行以下命令，生成口令加密文件

    travis encrypt GH_TOKEN=LONGTOKENFROMGITHUB --add env.global

    加解密过程示意图

    加密流程图

    Token创建官方说明

    https://help.github.com/articles/creating-an-access-token-for-command-line-use/

  4. 在源文件仓库中创建.travis.yml文件，并配置如下内容，主要作用是在提交代码是出发travis-ci从github中下载代码，并安装Pelican，通过执行Pelican生成静态文件，再提交到静态文件仓库中

    language: python
python:
  - 2.7.6
env:
  global:
  - GH_OWNER=ijyun
  - GH_PROJECT_NAME=ijyun.github.com
  - secure: **************
install:
  - pip install pelican
  - pip install markdown
before_script:
  - git config --global user.name "龙井"
  - git config --global user.email "ijun@outlook.com"
  - git config --global github.user ijyun
  # 下载博客仓库源文件
  - git clone https://${GH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME}
script:
  - pelican content/ -s pelicanconf.py -o ${GH_PROJECT_NAME}
after_success:
  - cd ijyun.github.com
  - git add -f .
  # 以源文件仓库的提交日志作为静态站点更新的日志
  - git commit -am "更新仓库："${TRAVIS_COMMIT}
  - git push https://${GH_TOKEN}@github.com/${GH_OWNER}/${GH_PROJECT_NAME} master

  5. 检查.travis.yml格式

    将文件内容复制到网站http://lint.travis-ci.org/进行检测

  6. 提交到源文件仓库进行构建 构建结果图

参考资料：http://notes.iissnan.com/2016/publishing-github-pages-with-travis-ci/

Travis CI官方文档：https://docs.travis-ci.com/

其他方式

  1. fabric
  2. make

3.3 主题

主题下载地址

http://www.pelicanthemes.com/

选用主题

  1. 我选择的主题：nice-blog
  2. 配置方式：THEME = "/vagrant/longjing/nice-blog"

配置

配置文件：pelicanconf.py

  1. 配置静态文件目录

    STATIC_PATHS = ['images', 'pdfs','blog', 'downloads']

  2. 配置文章存储路径和URL显示

    ARTICLE_SAVE_AS = '{date:%Y/%m/%d}/{slug}.html'

    ARTICLE_URL = '{date:%Y/%m/%d}/{slug}.html'

  3. 配置文章目录

    ARTICLE_PATHS = ['blogs']

  4. 配置主题

    THEME = "/vagrant/longjing/nice-blog"

  5. 摘要显示长度配置

    SUMMARY_MAX_LENGTH

  6. pages目录下的文章是否在导航菜单中显示

    DISPLAY_PAGES_ON_MENU # 缺省值为True

  7. 社交网站

    SOCIAL = (('github', 'https://github.com/ijyun'),)

参考文档：https://github.com/getpelican/pelican/wiki/Tutorials

附：

Continue reading the other documentation sections for more detail, and check out the Pelican wiki’s Tutorials page for links to community-published tutorials.

tags: PelicanPython博客2016