Static site generator that supports Markdown and reST syntax. Powered by Python.
  • Python 85.3%
  • CSS 8.7%
  • Jinja 6%
Find a file
Helmut Grohne 3f304a2e92 change the inhibition value of *_SAVE_AS to ''
Previously, the documentation claimed the value of None for this purpose
even though False was used for certain defaults. The values False and
None cause warnings to be emitted from URLWrapper._from_settings though,
so the new way of inhibiting page generation is to set a *_SAVE_AS value
to the empty string.
2014-03-31 19:38:49 +02:00
docs change the inhibition value of *_SAVE_AS to '' 2014-03-31 19:38:49 +02:00
pelican change the inhibition value of *_SAVE_AS to '' 2014-03-31 19:38:49 +02:00
samples The modified attribute no longer has a default value. 2013-11-17 23:40:11 +01:00
.gitattributes Fixed line ending problems by adding a .gitattributes file 2012-11-29 15:00:44 +01:00
.gitignore Port pelican to python 3. 2013-01-11 03:20:09 +01:00
.mailmap .mailmap: Add mappings to consolidate author names and emails 2013-04-12 10:51:48 -04:00
.travis.yml travis: Use dev_requirements.txt for dependencies 2014-01-10 07:33:41 +00:00
bumpr.rc Modify sed command in bumpr.rc to support BSD 2013-09-24 21:37:53 +02:00
CONTRIBUTING.rst Add squashing to CONTRIBUTING docs. Fix URLs. 2014-02-14 14:37:54 -08:00
dev_requirements.txt Revert to newly-revived Typogrify project 2014-02-12 10:54:56 -08:00
LICENSE Include the complete license rather than the short version. See #103 2011-04-26 13:46:02 +01:00
MANIFEST.in Don't include all the .py files in the root folder 2013-06-07 00:50:51 +02:00
README.rst Prepare version 3.3.1.dev for next development cycle 2013-09-24 21:57:28 +02:00
setup.cfg Build Pelican wheels in universal format 2013-11-13 13:44:28 -08:00
setup.py Work around pytz & pip 1.4+ problem. Fixes #996. 2013-08-08 12:08:30 -07:00
THANKS Document video support in Markdown and reST. 2013-10-25 10:52:13 +02:00
tox.ini Use dev_requirements.txt for tox dependencies 2014-01-10 07:34:13 +00:00

Pelican
=======

.. image:: https://secure.travis-ci.org/getpelican/pelican.png?branch=master
   :target: http://travis-ci.org/getpelican/pelican
   :alt: Travis-ci: continuous integration status.

Pelican is a static site generator, written in Python_.

* Write your weblog entries directly with your editor of choice (vim!)
  in reStructuredText_ or 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_ templates)
* 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 `Pelican documentation`_ for more information.

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

"Pelican" is an anagram for *calepin*, which means "notebook" in French. ;)

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

You can access the source code at: https://github.com/getpelican/pelican

If you feel hackish, have a look at the explanation of `Pelican's internals`_.

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_.
That's open source, dude!

Send a message to "authors at getpelican dot com" with any requests/feedback! You
can also join the team at `#pelican on Freenode`_ (or if you don't have an IRC
client handy, use the webchat_ for quick feedback.

.. Links

.. _Python: http://www.python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Markdown: http://daringfireball.net/projects/markdown/
.. _Jinja2: http://jinja.pocoo.org/
.. _`Pelican documentation`: http://docs.getpelican.com/latest/
.. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html
.. _`#pelican on Freenode`: irc://irc.freenode.net/pelican
.. _webchat: http://webchat.freenode.net/?channels=pelican&uio=d4
.. _contribute: http://docs.getpelican.com/en/latest/contribute.html