Static site generator that supports Markdown and reST syntax. Powered by Python.
  • Python 85.3%
  • CSS 8.7%
  • Jinja 6%
Find a file
Justin Mayer 72421d4438 Support arbitrary SSH ports in pelican-quickstart
Some folks choose non-standard SSH ports for security reasons, so it
makes sense to try to support that in the pelican-quickstart script.
2012-07-05 11:34:45 -07:00
docs Merge branch 'master' of github.com:ametaireau/pelican into DeleteContentsNotDirectory 2012-07-04 15:12:39 -07:00
pelican Support arbitrary SSH ports in pelican-quickstart 2012-07-05 11:34:45 -07:00
samples Add support for status: hidden in pages 2012-06-26 19:26:43 -07:00
tests Merge pull request #394 from tbunnyman/issue#380 2012-07-05 02:19:51 -07:00
.gitignore Remove errant .DS_Store and add to .gitignore 2012-06-16 11:23:55 -07:00
.hgignore Little changes to the hgignore file. 2010-10-16 20:03:06 +01:00
.hgtags Added tag 2.5.3 for changeset 1f9dd44b5464 2010-12-19 01:30:18 +00:00
.travis.yml Add markdown as a dev requirement. 2012-04-01 03:22:53 +02:00
CHANGELOG Update CHANGELOG 2012-05-15 11:58:40 +03:00
dev_requirements.txt we need jinja >= 2.4 2012-06-26 16:28:00 +02:00
LICENSE Include the complete license rather than the short version. See #103 2011-04-26 13:46:02 +01:00
MANIFEST.in Add template files to MANIFEST.in 2012-06-13 21:54:40 +02:00
README.rst Add travis-ci build-image support on the README 2012-03-11 18:07:08 +01:00
setup.py we need jinja >= 2.4 2012-06-26 16:28:00 +02:00
THANKS Thanks Manuel :) 2011-07-29 23:35:57 +03:00
TODO add ideas 2011-08-11 11:24:41 +02:00
tox.ini Add beautifulSoup in the dev deps 2012-06-10 13:17:52 +02:00

Pelican
#######

.. image:: https://secure.travis-ci.org/ametaireau/pelican.png?branch=master

Pelican is a simple weblog generator, written in `Python <http://www.python.org/>`_.

* 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
* Easy to interface with DVCSes and web hooks
* Completely static output is easy to host anywhere

Features
--------

Pelican currently supports:

* 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.)
* Theming support (themes are created using `jinja2 <http://jinja.pocoo.org/>`_)
* 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)

Have a look at `the documentation <http://pelican.notmyidea.org/en/latest/>`_ for
more information.

Why the name "Pelican"?
------------------------

Heh, you didn't notice? "Pelican" is an anagram for « Calepin » ;)

Source code
-----------

You can access the source code via git at: https://github.com/ametaireau/pelican

If you feel hackish, have a look at the explanation of `Pelican's internals
<http://pelican.notmyidea.org/en/latest/internals.html>`_.

Feedback / Contact us
---------------------

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 
<http://pelican.notmyidea.org/en/latest/contribute.html>`_. That's open source, dude!

Contact me at "alexis at notmyidea dot org" for any request/feedback! You can
also join the team at `#pelican on irc.freenode.org 
<irc://irc.freenode.net/pelican>`_ 
(or if you don't have any IRC client, use `the webchat
<http://webchat.freenode.net/?channels=pelican&uio=d4>`_)
for quick feedback.