2010-08-14 05:45:16 +02:00
|
|
|
Pelican
|
|
|
|
|
#######
|
|
|
|
|
|
2010-08-17 22:59:59 +02:00
|
|
|
Pelican is a simple weblog generator, writen in python.
|
2010-10-14 01:18:50 +01:00
|
|
|
|
2010-08-17 22:59:59 +02:00
|
|
|
* Write your weblog entries directly with your editor of choice (vim!) and
|
2010-10-31 01:15:35 +00:00
|
|
|
directly in restructured text, or markdown.
|
2010-08-17 22:59:59 +02:00
|
|
|
* A simple cli-tool to (re)generate the weblog.
|
|
|
|
|
* Easy to interface with DVCSes and web hooks
|
2010-10-14 01:18:08 +01:00
|
|
|
* Completely static output, so easy to host anywhere !
|
2010-08-17 22:59:59 +02:00
|
|
|
|
2010-10-30 16:47:35 +01:00
|
|
|
Files metadatas
|
2010-08-17 22:59:59 +02:00
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Pelican tries to be smart enough to get the informations he needs from the
|
2010-10-30 16:47:35 +01:00
|
|
|
filesystem (for instance, about the category of your articles), but you need to
|
|
|
|
|
provide by hand some of those informations in your files.
|
2010-08-17 22:59:59 +02:00
|
|
|
|
|
|
|
|
You could provide the metadata in the restructured text files, using the
|
|
|
|
|
following syntax::
|
|
|
|
|
|
|
|
|
|
My super title
|
|
|
|
|
##############
|
|
|
|
|
|
2010-10-15 01:26:21 +01:00
|
|
|
:date: 2010-10-03 10:20
|
|
|
|
|
:tags: thats, awesome
|
|
|
|
|
:category: yeah
|
|
|
|
|
:author: Alexis Metaireau
|
2010-08-17 22:59:59 +02:00
|
|
|
|
2010-10-31 01:15:35 +00:00
|
|
|
|
|
|
|
|
You can also use a mardown syntax::
|
|
|
|
|
|
|
|
|
|
Date: 2010-12-03
|
|
|
|
|
Title: My super title
|
|
|
|
|
|
|
|
|
|
Put you content here.
|
|
|
|
|
|
2010-10-30 16:47:35 +01:00
|
|
|
Note that only the `date` metadata is mandatory, so you just have to add that in i
|
|
|
|
|
your files. The category can also be determined by the directory where the rst file
|
|
|
|
|
is. For instance, the category of `python/foobar/myfoobar.rst` is `foobar`.
|
|
|
|
|
|
|
|
|
|
Getting started — Generate your blog
|
|
|
|
|
-------------------------------------
|
|
|
|
|
|
|
|
|
|
Yeah? You're ready? Let's go ! You can install pelican in a lot of different
|
|
|
|
|
ways, the simpler one is via pip::
|
|
|
|
|
|
|
|
|
|
$ pip install pelican
|
|
|
|
|
|
|
|
|
|
Then, you have just to launch pelican, like this::
|
|
|
|
|
|
|
|
|
|
$ pelican /path/to/your/content/
|
|
|
|
|
|
|
|
|
|
And… that's all! You can see your weblog generated on the content/ folder.
|
|
|
|
|
|
|
|
|
|
This one will just generate a simple output, with the default theme. It's not
|
|
|
|
|
really sexy, as it's a simple HTML output (without any style).
|
|
|
|
|
|
|
|
|
|
You can create your own style if you want, have a look to the help to see all
|
|
|
|
|
the options you can use::
|
|
|
|
|
|
|
|
|
|
$ pelican --help
|
|
|
|
|
|
2010-08-14 05:45:16 +02:00
|
|
|
Why the name "Pelican" ?
|
|
|
|
|
------------------------
|
|
|
|
|
|
2010-08-17 22:59:59 +02:00
|
|
|
Heh, you didnt noticed? "Pelican" is an anagram for "Calepin" ;)
|
|
|
|
|
|
2010-10-30 16:47:35 +01:00
|
|
|
Source code
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
You can access the source code via mercurial at http://hg.notmyidea.org/pelican/
|
|
|
|
|
or via git on http://github.com/ametaireau/pelican/
|
|
|
|
|
|
2010-08-17 22:59:59 +02:00
|
|
|
Feedback !
|
|
|
|
|
----------
|
2010-08-14 05:45:16 +02:00
|
|
|
|
2010-08-17 22:59:59 +02:00
|
|
|
If you want to see new features in Pelican, dont hesitate to tell me, to clone
|
|
|
|
|
the repository, etc. That's open source, dude!
|
2010-10-29 02:50:27 +01:00
|
|
|
|
2010-10-30 16:47:35 +01:00
|
|
|
Contact me at "alexis at notmyidea dot org" for any request/feedback !
|
