mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Update the README
This commit is contained in:
parent
8d97bc12b0
commit
fee58a6d25
1 changed files with 47 additions and 1 deletions
48
README.rst
48
README.rst
|
|
@ -1,8 +1,54 @@
|
||||||
Pelican
|
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" ?
|
Why the name "Pelican" ?
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
In addition, pelican is an anagram for "calepin" ;)
|
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!
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue