Pelican Documentation

Pelican Documentation

Release 3.4.0 Alexis M?taireau

July 05, 2014

Contents

1 Features

3

2 Why the name "Pelican"?

5

3 Source code

7

4 How to get help, contribute, or provide feedback

9

5 Documentation

11

5.1 Quickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5.2 Installing Pelican . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

5.3 Writing content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.4 Publish your site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

5.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

5.6 Creating themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

5.7 Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

5.8 pelican-themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

5.9 Importing an existing site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

5.10 Frequently Asked Questions (FAQ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

5.11 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

5.12 Contributing and feedback guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

5.13 Pelican internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

5.14 Some history about Pelican . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

5.15 Release history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

i

ii

Pelican Documentation, Release 3.4.0

Pelican is a static site generator, written in Python. Highlights include: ? Write your content directly with your editor of choice in reStructuredText or Markdown formats ? Includes a simple CLI tool to (re)generate your site ? Easy to interface with distributed version control systems and web hooks ? Completely static output is easy to host anywhere

Ready to get started? Check out the Quickstart guide.

Contents

1

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download