Pelican 3.5.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.

Features¶

Pelican 3 currently supports:

  • Articles (e.g., blog posts) and pages (e.g., “About”, “Projects”, “Contact”)
  • Comments, via an external service (Disqus). If you prefer to have more control over your comment data, self-hosted comments are another option. Check out the Pelican Plugins repository for more details.
  • Theming support (themes are created using Jinja2 templates)
  • Publication of articles in multiple languages
  • Atom/RSS feeds
  • Code syntax highlighting
  • Import from WordPress, Dotclear, or RSS feeds
  • Integration with external tools: Twitter, Google Analytics, etc. (optional)
  • Fast rebuild times thanks to content caching and selective output writing

Why the name “Pelican”?¶

“Pelican” is an anagram for calepin, which means “notebook” in French. ;)

Source code¶

You can access the source code at: https://github.com/getpelican/pelican

How to get help, contribute, or provide feedback¶

See our feedback and contribution submission guidelines.

Documentation¶

  • Quickstart
    • Installation
    • Create a project
    • Create an article
    • Generate your site
    • Preview your site
  • Installing Pelican
    • Optional packages
    • Dependencies
    • Upgrading
  • Writing content
    • Articles and pages
    • File metadata
    • Pages
    • Linking to internal content
    • Importing an existing site
    • Translations
    • Syntax highlighting
    • Publishing drafts
  • Publish your site
    • Site generation
    • Deployment
    • Automation
  • Settings
    • Basic settings
    • URL settings
    • Template pages
    • Path metadata
    • Feed settings
    • Pagination
    • Tag cloud
    • Translations
    • Ordering content
    • Themes
    • Logging
    • Reading only modified content
    • Writing only selected content
    • Example settings
  • Creating themes
    • Structure
    • Templates and variables
    • Feeds
    • Inheritance
  • Plugins
    • How to use plugins
    • Where to find plugins
    • How to create plugins
    • List of signals
    • Recipes
  • pelican-themes
    • Description
    • Examples
  • Importing an existing site
    • Description
    • Dependencies
    • Usage
    • Examples
    • Tests
  • Frequently Asked Questions (FAQ)
    • What’s the best way to communicate a problem, question, or suggestion?
    • How can I help?
    • Is it mandatory to have a configuration file?
    • Changes to the setting file take no effect
    • I’m creating my own theme. How do I use Pygments for syntax highlighting?
    • How do I create my own theme?
    • I want to use Markdown, but I got an error.
    • Can I use arbitrary metadata in my templates?
    • How do I assign custom templates on a per-page basis?
    • How can I override the generated URL of a specific page or article?
    • How can I use a static page as my home page?
    • What if I want to disable feed generation?
    • I’m getting a warning about feeds generated without SITEURL being set properly
    • My feeds are broken since I upgraded to Pelican 3.x
    • Is Pelican only suitable for blogs?
    • Why does Pelican always write all HTML files even with content caching enabled?
    • How to process only a subset of all articles?
  • Tips
    • Publishing to GitHub
    • How to add YouTube or Vimeo Videos
  • Contributing and feedback guidelines
    • Filing issues
    • How to get help
    • Contributing code
    • Testing on Python 2 and 3
    • Limiting extraneous log messages
    • Outputting traceback in the logs
  • Pelican internals
    • Overall structure
    • How to implement a new reader?
    • How to implement a new generator?
  • Some history about Pelican
    • Use case
    • Design process
    • In more detail
  • Release history
    • 3.5.0 (2014-11-04)
    • 3.4.0 (2014-07-01)
    • 3.3.0 (2013-09-24)
    • 3.2.1 and 3.2.2
    • 3.2 (2013-04-24)
    • 3.1 (2012-12-04)
    • 3.0 (2012-08-08)
    • 2.8 (2012-02-28)
    • 2.7 (2011-06-11)
    • 2.6 (2011-03-08)
    • 2.5 (2010-11-20)
    • 2.4 (2010-11-06)
    • 2.3 (2010-10-31)
    • 2.2 (2010-10-30)
    • 2.1 (2010-10-30)
    • 2.0 (2010-10-30)
    • 1.2 (2010-09-28)
    • 1.1 (2010-08-19)