2010-08-14 05:45:16 +02:00
|
|
|
Pelican
|
|
|
|
|
#######
|
|
|
|
|
|
2012-08-04 17:13:57 +02:00
|
|
|
.. image:: https://secure.travis-ci.org/getpelican/pelican.png?branch=master
|
2012-03-11 18:07:08 +01:00
|
|
|
|
2012-08-04 11:15:44 -07:00
|
|
|
Pelican is a static site generator, written in `Python <http://www.python.org/>`_.
|
2010-10-14 01:18:50 +01:00
|
|
|
|
2012-03-06 06:13:17 -08:00
|
|
|
* 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
|
2010-08-17 22:59:59 +02:00
|
|
|
* Easy to interface with DVCSes and web hooks
|
2012-03-06 06:13:17 -08:00
|
|
|
* Completely static output is easy to host anywhere
|
2010-08-17 22:59:59 +02:00
|
|
|
|
2010-11-07 14:13:20 +00:00
|
|
|
Features
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Pelican currently supports:
|
|
|
|
|
|
2012-03-06 06:13:17 -08:00
|
|
|
* 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.)
|
2012-08-04 11:15:44 -07:00
|
|
|
* Theming support (themes are created using `Jinja2 <http://jinja.pocoo.org/>`_)
|
2012-03-06 06:13:17 -08:00
|
|
|
* PDF generation of the articles/pages (optional)
|
|
|
|
|
* Publication of articles in multiple languages
|
|
|
|
|
* Atom/RSS feeds
|
|
|
|
|
* Code syntax highlighting
|
2012-08-04 11:15:44 -07:00
|
|
|
* Compilation of `LESS CSS <http://lesscss.org/>`_ (optional)
|
2012-03-06 06:13:17 -08:00
|
|
|
* Import from WordPress, Dotclear, or RSS feeds
|
|
|
|
|
* Integration with external tools: Twitter, Google Analytics, etc. (optional)
|
|
|
|
|
|
2012-07-31 09:41:45 -07:00
|
|
|
Have a look at `the documentation <http://docs.getpelican.com/latest/>`_ for
|
2012-03-06 06:13:17 -08:00
|
|
|
more information.
|
|
|
|
|
|
|
|
|
|
Why the name "Pelican"?
|
2010-08-14 05:45:16 +02:00
|
|
|
------------------------
|
|
|
|
|
|
2012-08-04 11:15:44 -07:00
|
|
|
"Pelican" is an anagram for *calepin*, which means "notebook" in French. ;)
|
2010-08-17 22:59:59 +02:00
|
|
|
|
2010-10-30 16:47:35 +01:00
|
|
|
Source code
|
|
|
|
|
-----------
|
|
|
|
|
|
2012-08-04 11:15:44 -07:00
|
|
|
You can access the source code at: https://github.com/getpelican/pelican
|
2010-10-30 16:47:35 +01:00
|
|
|
|
2012-03-06 08:12:15 -08:00
|
|
|
If you feel hackish, have a look at the explanation of `Pelican's internals
|
2012-08-04 11:15:44 -07:00
|
|
|
<http://docs.getpelican.com/en/latest/internals.html>`_.
|
2010-12-02 03:22:24 +00:00
|
|
|
|
2011-06-13 18:42:31 +02:00
|
|
|
Feedback / Contact us
|
2012-03-06 08:12:15 -08:00
|
|
|
---------------------
|
2010-08-14 05:45:16 +02:00
|
|
|
|
2012-03-06 08:12:15 -08:00
|
|
|
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
|
2012-08-04 11:15:44 -07:00
|
|
|
<http://docs.getpelican.com/en/latest/contribute.html>`_. That's open source, dude!
|
2010-10-29 02:50:27 +01:00
|
|
|
|
2012-08-04 11:15:44 -07:00
|
|
|
Send a message to "alexis at notmyidea dot org" with any requests/feedback! You
|
|
|
|
|
can also join the team at
|
|
|
|
|
`#pelican on Freenode <irc://irc.freenode.net/pelican>`_ (or if you don't have
|
|
|
|
|
a IRC client handy, use `the webchat
|
2011-06-13 18:26:31 +02:00
|
|
|
<http://webchat.freenode.net/?channels=pelican&uio=d4>`_)
|
|
|
|
|
for quick feedback.
|
