Static site generator that supports Markdown and reST syntax. Powered by Python.
  • Python 85.3%
  • CSS 8.7%
  • Jinja 6%
Find a file
Kyle Fuller 7732482738 Merge pull request #452 from clinthowarth/patch-1
Update README to new project home
2012-08-04 08:11:51 -07:00
docs Various fixes and improvements to the docs 2012-08-01 18:20:12 -07:00
pelican Make develop_server.sh executable. Refs #443. 2012-08-03 08:26:19 -07:00
samples Merge remote-tracking branch 'origin/master' into fix-functional-tests 2012-07-05 01:22:31 +02:00
tests typogrify also does some changes on the abbr 2012-07-27 00:34:47 +02:00
.gitignore Remove errant .DS_Store and add to .gitignore 2012-06-16 11:23:55 -07:00
.hgignore Little changes to the hgignore file. 2010-10-16 20:03:06 +01:00
.hgtags Added tag 2.5.3 for changeset 1f9dd44b5464 2010-12-19 01:30:18 +00:00
.travis.yml Add markdown as a dev requirement. 2012-04-01 03:22:53 +02:00
dev_requirements.txt we need jinja >= 2.4 2012-06-26 16:28:00 +02:00
LICENSE Include the complete license rather than the short version. See #103 2011-04-26 13:46:02 +01:00
MANIFEST.in Include test assets in distribution 2012-07-20 11:13:35 +02:00
README.rst Update README to new project home 2012-08-03 23:34:46 -03:00
setup.py Update Pelican project domain in a few more places 2012-07-31 09:41:45 -07:00
THANKS Thanks Manuel :) 2011-07-29 23:35:57 +03:00
TODO add ideas 2011-08-11 11:24:41 +02:00
tox.ini Add beautifulSoup in the dev deps 2012-06-10 13:17:52 +02:00

Pelican
#######

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

Pelican is a simple weblog 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
* 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"?
------------------------

Heh, you didn't notice? "Pelican" is an anagram for « Calepin » ;)

Source code
-----------

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

If you feel hackish, have a look at the explanation of `Pelican's internals
<http://pelican.notmyidea.org/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://pelican.notmyidea.org/en/latest/contribute.html>`_. That's open source, dude!

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