This documentation is for the version of Pelican currently under development. Were you looking for version 3.3.0 documentation?
Pelican is a static site generator, written in Python.
- Write your content directly with your editor of choice (vim!) in reStructuredText, Markdown, or AsciiDoc 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
Pelican 3 currently supports:
- Articles (e.g., blog posts) and pages (e.g., “About”, “Projects”, “Contact”)
- 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)
- 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. ;)
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. For a more immediate response, you can also join the team via IRC at #pelican on Freenode — if you don’t have an IRC client handy, use the webchat for quick feedback. If you ask a question via IRC and don’t get an immediate response, don’t leave the channel! It may take a few hours because of time zone differences, but if you are patient and remain in the channel, someone will almost always respond to your inquiry.
A French version of the documentation is available at Pelican.
- Getting started
- How to create themes for Pelican
- Pelican internals
- Import from other blog software
- 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?
- I’m creating my own theme. How do I use Pygments for syntax highlighting?
- How do I create my own theme?
- I’m using Markdown and getting No valid files found in content errors.
- 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 contribute
- Some history about Pelican
- Release history