2014-06-13 16:13:37 -04:00
|
|
|
Pelican |build-status| |coverage-status|
|
|
|
|
|
========================================
|
2012-08-06 18:12:54 +02:00
|
|
|
|
2012-08-06 07:40:10 -07:00
|
|
|
Pelican is a static site generator, written in Python_.
|
2010-10-14 01:18:50 +01:00
|
|
|
|
2012-08-06 18:12:54 +02:00
|
|
|
* Write your weblog entries directly with your editor of choice (vim!)
|
2012-08-06 07:40:10 -07:00
|
|
|
in reStructuredText_ or Markdown_
|
2012-03-06 06:13:17 -08:00
|
|
|
* 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-06 07:40:10 -07:00
|
|
|
* Theming support (themes are created using Jinja2_ templates)
|
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
|
|
|
|
|
* Import from WordPress, Dotclear, or RSS feeds
|
|
|
|
|
* Integration with external tools: Twitter, Google Analytics, etc. (optional)
|
2014-04-20 14:34:52 +02:00
|
|
|
* Fast rebuild times thanks to content caching and selective output writing.
|
2012-03-06 06:13:17 -08:00
|
|
|
|
2012-08-06 07:40:10 -07:00
|
|
|
Have a look at the `Pelican documentation`_ for more information.
|
2012-03-06 06:13:17 -08:00
|
|
|
|
|
|
|
|
Why the name "Pelican"?
|
2012-08-06 07:40:10 -07:00
|
|
|
-----------------------
|
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-08-06 07:40:10 -07:00
|
|
|
If you feel hackish, have a look at the explanation of `Pelican's internals`_.
|
2010-12-02 03:22:24 +00:00
|
|
|
|
2014-05-26 12:32:05 +02:00
|
|
|
How to get help, contribute, or provide feedback
|
|
|
|
|
------------------------------------------------
|
2010-08-14 05:45:16 +02:00
|
|
|
|
2014-05-26 12:32:05 +02:00
|
|
|
See our `contribution submission and feedback guidelines <CONTRIBUTING.rst>`_.
|
2012-08-06 07:40:10 -07:00
|
|
|
|
|
|
|
|
.. Links
|
|
|
|
|
|
|
|
|
|
.. _Python: http://www.python.org/
|
|
|
|
|
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
|
|
|
|
.. _Markdown: http://daringfireball.net/projects/markdown/
|
|
|
|
|
.. _Jinja2: http://jinja.pocoo.org/
|
2014-05-26 12:32:05 +02:00
|
|
|
.. _`Pelican documentation`: http://docs.getpelican.com/
|
2012-08-06 07:40:10 -07:00
|
|
|
.. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html
|
2014-06-13 16:13:37 -04:00
|
|
|
|
2015-01-02 01:11:51 -08:00
|
|
|
.. |build-status| image:: https://img.shields.io/travis/getpelican/pelican/master.svg
|
2014-06-13 16:13:37 -04:00
|
|
|
:target: https://travis-ci.org/getpelican/pelican
|
|
|
|
|
:alt: Travis CI: continuous integration status
|
|
|
|
|
.. |coverage-status| image:: https://img.shields.io/coveralls/getpelican/pelican.svg
|
|
|
|
|
:target: https://coveralls.io/r/getpelican/pelican
|
|
|
|
|
:alt: Coveralls: code coverage status
|
|
|
|
|
|
