2010-12-14 15:31:11 +00:00
|
|
|
Pelican
|
|
|
|
|
#######
|
|
|
|
|
|
2012-08-04 11:15:44 -07:00
|
|
|
Pelican is a static site generator, written in `Python <http://www.python.org/>`_.
|
2010-12-14 15:31:11 +00:00
|
|
|
|
2012-08-04 11:15:44 -07: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-12-14 15:31:11 +00: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-12-14 15:31:11 +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-01 18:20:12 -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-01 18:20:12 -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)
|
2010-12-14 15:31:11 +00:00
|
|
|
|
2012-08-01 18:20:12 -07:00
|
|
|
Why the name "Pelican"?
|
2010-12-14 15:31:11 +00:00
|
|
|
========================
|
|
|
|
|
|
2012-08-04 11:15:44 -07:00
|
|
|
"Pelican" is an anagram for *calepin*, which means "notebook" in French. ;)
|
2010-12-14 15:31:11 +00:00
|
|
|
|
|
|
|
|
Source code
|
|
|
|
|
===========
|
|
|
|
|
|
2012-08-04 11:15:44 -07:00
|
|
|
You can access the source code at: https://github.com/getpelican/pelican
|
2010-12-14 15:31:11 +00:00
|
|
|
|
2011-06-13 18:42:31 +02:00
|
|
|
Feedback / Contact us
|
|
|
|
|
=====================
|
2010-12-14 15:31:11 +00:00
|
|
|
|
2012-08-04 11:15:44 -07: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 :doc:`contribute<contribute>`.
|
|
|
|
|
That's open source, dude!
|
2010-12-14 15:31:11 +00:00
|
|
|
|
2012-08-01 18:20:12 -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.
|
2010-12-14 15:31:11 +00:00
|
|
|
|
2010-12-15 18:01:29 +00:00
|
|
|
Documentation
|
|
|
|
|
=============
|
|
|
|
|
|
2012-03-06 06:13:17 -08:00
|
|
|
A French version of the documentation is available at :doc:`fr/index`.
|
2011-01-25 16:35:59 +00:00
|
|
|
|
2010-12-15 18:01:29 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2011-08-03 22:06:10 +02:00
|
|
|
|
2010-12-15 18:01:29 +00:00
|
|
|
getting_started
|
|
|
|
|
settings
|
|
|
|
|
themes
|
2011-06-18 01:03:53 +02:00
|
|
|
plugins
|
2010-12-15 18:01:29 +00:00
|
|
|
internals
|
2011-07-22 02:12:10 +02:00
|
|
|
pelican-themes
|
2011-08-03 22:06:10 +02:00
|
|
|
importer
|
2011-01-19 16:22:15 +01:00
|
|
|
faq
|
2011-08-19 23:01:01 +02:00
|
|
|
tips
|
2011-05-10 23:41:27 +01:00
|
|
|
contribute
|
2011-11-30 21:11:50 +01:00
|
|
|
report
|
2012-07-18 18:41:09 +02:00
|
|
|
changelog
|
