Pelican
#######

.. image:: https://secure.travis-ci.org/getpelican/pelican.png?branch=master

Pelican is a static site generator, written in `Python <http://www.python.org/>`_.

* Write your weblog entries directly with your editor of choice (vim!) 
  in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ or `Markdown <http://daringfireball.net/projects/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

Features
--------

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 <http://jinja.pocoo.org/>`_)
* PDF generation of the articles/pages (optional)
* Publication of articles in multiple languages
* Atom/RSS feeds
* Code syntax highlighting
* Compilation of `LESS CSS <http://lesscss.org/>`_ (optional)
* Import from WordPress, Dotclear, or RSS feeds
* Integration with external tools: Twitter, Google Analytics, etc. (optional)

Have a look at `the documentation <http://docs.getpelican.com/latest/>`_ 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: https://github.com/getpelican/pelican

If you feel hackish, have a look at the explanation of `Pelican's internals
<http://docs.getpelican.com/en/latest/internals.html>`_.

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 
<http://docs.getpelican.com/en/latest/contribute.html>`_. That's open source, dude!

Send a message to "alexis at notmyidea dot org" with any requests/feedback! You
can also join the team at
`#pelican on Freenode <irc://irc.freenode.net/pelican>`_ (or if you don't have 
a IRC client handy, use `the webchat
<http://webchat.freenode.net/?channels=pelican&uio=d4>`_)
for quick feedback.