Skip to main content

A tool to generate a static blog from reStructuredText or Markdown input files.

Project description


Travis-ci: continuous integration status.

Pelican is a static site generator, written in Python.

  • Write your weblog entries directly with your editor of choice (vim!) in reStructuredText or Markdown

  • Includes a simple CLI tool to (re)generate the weblog

  • Easy to interface with DVCSes and web hooks

  • Completely static output is easy to host anywhere


Pelican currently supports:

  • Blog articles and pages

  • Comments, via an external service (Disqus). (Please note that while useful, Disqus is an external service, and thus the comment data will be somewhat outside of your control and potentially subject to data loss.)

  • Theming support (themes are created using Jinja2 templates)

  • PDF generation of the articles/pages (optional)

  • 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)

Have a look at the Pelican documentation for more information.

Why the name “Pelican”?

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

Source code

You can access the source code at:

If you feel hackish, have a look at the explanation of Pelican’s internals.

Feedback / Contact us

If you want to see new features in Pelican, don’t hesitate to offer suggestions, clone the repository, etc. There are many ways to contribute. That’s open source, dude!

Send a message to “authors at getpelican dot com” with any requests/feedback! You can also join the team at #pelican on Freenode (or if you don’t have an IRC client handy, use the webchat for quick feedback.

Release history

3.2 (2013-04-24)

  • Support for Python 3!

  • Override page save-to location from meta-data (enables using a static page as the site’s home page, for example)

  • Time period archives (per-year, per-month, and per-day archives of posts)

  • Posterous blog import

  • Improve WordPress blog import

  • Migrate plugins to separate repository

  • Improve HTML parser

  • Provide ability to show or hide categories from menu using DISPLAY_CATEGORIES_ON_MENU option

  • Auto-regeneration can be told to ignore files via IGNORE_FILES setting

  • Improve post-generation feedback to user

  • For multilingual posts, use meta-data to designate which is the original and which is the translation

  • Add .mdown to list of supported Markdown file extensions

  • Document-relative URL generation (RELATIVE_URLS) is now off by default

3.1 (2012-12-04)

  • Importer now stores slugs within files by default. This can be disabled with the --disable-slugs option.

  • Improve handling of links to intra-site resources

  • Ensure WordPress import adds paragraphs for all types of line endings in post content

  • Decode HTML entities within WordPress post titles on import

  • Improve appearance of LinkedIn icon in default theme

  • Add GitHub and Google+ social icons support in default theme

  • Optimize social icons

  • Add FEED_ALL_ATOM and FEED_ALL_RSS to generate feeds containing all posts regardless of their language


  • Different feeds can now be enabled/disabled individually

  • Allow for blank author: if AUTHOR setting is not set, author won’t default to ${USER} anymore, and a post won’t contain any author information if the post author is empty

  • Move LESS and Webassets support from Pelican core to plugin

  • The DEFAULT_DATE setting now defaults to None, which means that articles won’t be generated unless date metadata is specified

  • Add FILENAME_METADATA setting to support metadata extraction from filename

  • Add gzip_cache plugin to compress common text files into a .gz file within the same directory as the original file, preventing the server (e.g. Nginx) from having to compress files during an HTTP call

  • Add support for AsciiDoc-formatted content

  • Add USE_FOLDER_AS_CATEGORY setting so that feature can be toggled on/off

  • Support arbitrary Jinja template files

  • Restore basic functional tests

  • New signals: generator_init, get_generators, and article_generate_preread

3.0 (2012-08-08)

  • Refactored the way URLs are handled

  • Improved the English documentation

  • Fixed packaging using setuptools entrypoints

  • Added typogrify support

  • Added a way to disable feed generation

  • Added support for DIRECT_TEMPLATES

  • Allow multiple extensions for content files

  • Added LESS support

  • Improved the import script

  • Added functional tests

  • Rsync support in the generated Makefile

  • Improved feed support (easily pluggable with Feedburner for instance)

  • Added support for abbr in reST

  • Fixed a bunch of bugs :-)

2.8 (2012-02-28)

  • Dotclear importer

  • Allow the usage of Markdown extensions

  • Themes are now easily extensible

  • Don’t output pagination information if there is only one page

  • Add a page per author, with all their articles

  • Improved the test suite

  • Made the themes easier to extend

  • Removed Skribit support

  • Added a pelican-quickstart script

  • Fixed timezone-related issues

  • Added some scripts for Windows support

  • Date can be specified in seconds

  • Never fail when generating posts (skip and continue)

  • Allow the use of future dates

  • Support having different timezones per language

  • Enhanced the documentation

2.7 (2011-06-11)

  • Use logging rather than echoing to stdout

  • Support custom Jinja filters

  • Compatibility with Python 2.5

  • Added a theme manager

  • Packaged for Debian

  • Added draft support

2.6 (2011-03-08)

  • Changes in the output directory structure

  • Makes templates easier to work with / create

  • Added RSS support (was Atom-only)

  • Added tag support for the feeds

  • Enhance the documentation

  • Added another theme (brownstone)

  • Added translations

  • Added a way to use cleaner URLs with a rewrite url module (or equivalent)

  • Added a tag cloud

  • Added an autoreloading feature: the blog is automatically regenerated each time a modification is detected

  • Translate the documentation into French

  • Import a blog from an RSS feed

  • Pagination support

  • Added Skribit support

2.5 (2010-11-20)

  • Import from Wordpress

  • Added some new themes (martyalchin / wide-notmyidea)

  • First bug report!

  • Linkedin support

  • Added a FAQ

  • Google Analytics support

  • Twitter support

  • Use relative URLs, not static ones

2.4 (2010-11-06)

  • Minor themes changes

  • Add Disqus support (so we have comments)

  • Another code refactoring

  • Added config settings about pages

  • Blog entries can also be generated in PDF

2.3 (2010-10-31)

  • Markdown support

2.2 (2010-10-30)

  • Prettify output

  • Manages static pages as well

2.1 (2010-10-30)

  • Make notmyidea the default theme

2.0 (2010-10-30)

  • Refactoring to be more extensible

  • Change into the setting variables

1.2 (2010-09-28)

  • Added a debug option

  • Added per-category feeds

  • Use filesystem to get dates if no metadata is provided

  • Add Pygments support

1.1 (2010-08-19)

  • First working version

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelican-3.2.tar.gz (2.3 MB view hashes)

Uploaded Source

Built Distribution

pelican-3.2-py2.py3-none-any.whl (327.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page