The document introduces Pelican, an open-source static site generator. It can convert reStructuredText and Markdown files into HTML files. The document covers how to install Pelican using virtualenv and pip install. It also discusses the basic folder structure and usage of Pelican, including generating HTML files from Markdown or reStructuredText content files organized into categories and tagged.

1. Introduction to Pelican
Internship @ Academia Sinica
Report #3
Presenter: Cheng-Jen Lee (Sol)
Email: cjlee AT iis.sinica.edu.tw
This work is licensed under a
Creative Commons Attribution-ShareAlike 3.0 Taiwan License.

2. Agenda
● Pelican
– Installation
– Usage
Oct 13, 2014 2

3. Pelican
● What is Pelican?
– A static site generator
– convert reStructuredText (or Markdown,
AsciiDoc) formats to HTML
– Easy to host anywhere
Oct 13, 2014 3

4. Pelican
● Installation
– $ sudo mkdir -p /usr/lib/pelican
– $ sudo chown `whoami` /usr/lib/pelican
– $ virtualenv --no-site-packages /usr/lib/pelican
– $ . /usr/lib/pelican/bin/activate
– $ pip install -e
git://github.com/getpelican/pelican#egg=pelican
– $ pelican-quickstart
Oct 13, 2014 4

5. Pelican
● Usage
– Folder structure
–
–
–
–
– Accept reStructuredText and Markdown
– Folders (under ./content) as Categories
Oct 13, 2014 5

6. Pelican
● A reStructuredText page
My super title
##############
:date: 2010-10-03 10:20
:tags: thats, awesome
:category: yeah
:slug: my-super-post
:author: Alexis Metaireau
:summary: Short version for
index and feeds
This is the content of my super
blog post.
● A Markdown page
Title: My super title
Date: 2010-12-03 10:20
Category: Python
Tags: pelican, publishing
Slug: my-super-post
Author: Alexis Metaireau
Summary: Short version for
index and feeds
This is the content of my super
blog post.
Oct 13, 2014 6

7. Pelican
● For static files (images, docs...etc)
– Create folders in ./content (ex. Images, files)
– ./pelicanconf.py
– Add STATIC_PATHS = ['images', 'files']
● Generate HTML
– make html
– HTML files will be saved in ./output
Oct 13, 2014 7

8. Thanks for your attention!
Any Q?
Oct 13, 2014 8