1
0
Fork 0
forked from github/pelican
Custom Pelican theme, colorway heavily inspired by rosepinetheme.com https://lugh.ch
  • CSS 68.5%
  • HTML 26.5%
  • JavaScript 5%
Find a file
Alexis Metaireau 26da943ceb Update TODO
2010-08-18 15:11:23 +02:00
pelican Remove trailing spaces 2010-08-18 15:09:04 +02:00
samples Add the notmyidea theme + settings as an example. 2010-08-18 15:10:43 +02:00
.hgignore Add a .hgignore file 2010-08-18 15:10:25 +02:00
README.rst Update the README 2010-08-17 22:59:59 +02:00
TODO Update TODO 2010-08-18 15:11:23 +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!