Static site generator that supports Markdown and reST syntax. Powered by Python.
  • Python 85.3%
  • CSS 8.7%
  • Jinja 6%
Find a file
2010-08-29 23:16:49 +02:00
bin Print errors if errors occurs :) Force to have a path specified. 2010-08-19 14:48:58 +02:00
pelican Print errors if errors occurs :) Force to have a path specified. 2010-08-19 14:48:58 +02:00
samples Add support of multiple static paths and feed generation. 2010-08-19 02:43:53 +02:00
.hgignore Add a .hgignore file 2010-08-18 15:10:25 +02:00
LICENSE Add a MANIFEST.in file for the archive generation 2010-08-19 14:23:41 +02:00
MANIFEST.in Add a MANIFEST.in file for the archive generation 2010-08-19 14:23:41 +02:00
README.rst Update the README 2010-08-17 22:59:59 +02:00
setup.py Print errors if errors occurs :) Force to have a path specified. 2010-08-19 14:48:58 +02:00
TODO Update the TODO list with ideas. 2010-08-29 23:16:49 +02:00

Pelican
#######

Pelican is a simple weblog generator, writen in python.
The goals are quite simple: 

* No more dynamic language online for weblogs, as it's not needed most 
  of the time.
* Write your weblog entries directly with your editor of choice (vim!) and
  directly in restructured text.
* A simple cli-tool to (re)generate the weblog.
* Easy to interface with DVCSes and web hooks


Getting started
---------------

Yeah? You're ready? Let's go !::

    $ pip install pelican
    $ pelican -p /path/to/your/content/
    ...

And… that's all! You can see your weblog generated on the content/ folder.


Metadata
---------

Pelican tries to be smart enough to get the informations he needs from the
filesystem (for instance, about date of creation of the files), but it seems to
be less reliable than static metadata.

You could provide the metadata in the restructured text files, using the
following syntax::

    My super title
    ##############

    .. date: 2010-10-03 10:20
    .. tags: thats, awesome
    .. category: yeah
    .. author: Alexis Metaireau

Why the name "Pelican" ?
------------------------

Heh, you didnt noticed? "Pelican" is an anagram for "Calepin" ;)

Feedback !
----------

If you want to see new features in Pelican, dont hesitate to tell me, to clone
the repository, etc. That's open source, dude!