Static site generator that supports Markdown and reST syntax. Powered by Python.
  • Python 85.3%
  • CSS 8.7%
  • Jinja 6%
Find a file
MinchinWeb a3c0360be2 Warn on old format settings
rather than trying to update them in place. Relies on the user to make the needed changes. Fallback is the default setting.
2018-10-13 09:40:25 -06:00
docs Convert RSS setting from %s to {slug}-style strings 2018-07-11 23:32:57 -06:00
pelican Warn on old format settings 2018-10-13 09:40:25 -06:00
requirements Add python3.6 test environment 2017-01-23 23:50:51 +01:00
samples Fix broken test 2018-07-12 18:11:08 -06:00
.coveragerc [coveralls] Exclude tests from coverage 2014-06-24 22:29:36 +01:00
.gitattributes Add missing .gitattributes attributes. Refs #2069 2016-12-23 08:03:57 -08:00
.gitignore support ssl in pelican.server with --ssl, --cert & --key 2018-04-07 15:06:38 -07:00
.mailmap .mailmap: Add mappings to consolidate author names and emails 2013-04-12 10:51:48 -04:00
.travis.yml Remove Python 3.7 from Tox 2018-07-12 18:26:05 -06:00
bumpr.rc Match space with POSIX sed when bumping via bumpr 2015-06-14 10:12:52 -07:00
CONTRIBUTING.rst Replace Fabric by Invoke. 2018-07-08 21:33:10 +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 missing *.markdown files to PyPI sdist 2015-08-07 14:46:12 +10:00
README.rst Remove download statistics badge from README 2016-12-12 11:07:13 -08:00
setup.cfg Revert setup.py changes. Ensure universal wheels. 2014-07-01 14:33:04 -07:00
setup.py Update setup.py 2018-04-11 19:14:47 +02:00
THANKS Fix broken test 2018-07-12 18:11:08 -06:00
tox.ini Tox: add Python 3.7 2018-07-12 16:30:43 -06:00

Pelican |build-status| |pypi-version|
=====================================

Pelican is a static site generator, written in Python_.

* Write content in reStructuredText_ or Markdown_ using your editor of choice
* Includes a simple command line tool to (re)generate site files
* Easy to interface with version control systems and web hooks
* Completely static output is simple to host anywhere


Features
--------

Pelican currently supports:

* Chronological content (e.g., articles, blog posts) as well as static pages
* Integration with external services (e.g., Google Analytics and Disqus)
* Site themes (created using Jinja2_ templates)
* Publication of articles in multiple languages
* Generation of Atom and RSS feeds
* Syntax highlighting via Pygments_
* Importing existing content from WordPress, Dotclear, and other services
* Fast rebuild times due to content caching and selective output writing

Check out `Pelican's documentation`_ for further information.


How to get help, contribute, or provide feedback
------------------------------------------------

See our `contribution submission and feedback guidelines <CONTRIBUTING.rst>`_.


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

Pelican's source code is `hosted on GitHub`_. If you feel like hacking,
take a look at `Pelican's internals`_.


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

"Pelican" is an anagram of *calepin*, which means "notebook" in French.


.. Links

.. _Python: http://www.python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Markdown: http://daringfireball.net/projects/markdown/
.. _Jinja2: http://jinja.pocoo.org/
.. _Pygments: http://pygments.org/
.. _`Pelican's documentation`: http://docs.getpelican.com/
.. _`Pelican's internals`: http://docs.getpelican.com/en/latest/internals.html
.. _`hosted on GitHub`: https://github.com/getpelican/pelican

.. |build-status| image:: https://img.shields.io/travis/getpelican/pelican/master.svg
   :target: https://travis-ci.org/getpelican/pelican
   :alt: Travis CI: continuous integration status
.. |pypi-version| image:: https://img.shields.io/pypi/v/pelican.svg
   :target: https://pypi.python.org/pypi/pelican
   :alt: PyPI: the Python Package Index