Static site generator that supports Markdown and reST syntax. Powered by Python.
  • Python 85.3%
  • CSS 8.7%
  • Jinja 6%
Find a file
Robert Rennison 7d07e228bf A feature to allow a pelican site to be deployed inside of a container.
- A new fabric target is introduced 'docker-rebuild'. This will rebuild a
  production version of the users site and deploy this by copying the
  pelican/output directory into the container image.

- The fabric target takes care of container management, cleaning up previous containers
  and instantiating new ones whenever the 'fab docker rebuild' command is issued.

- Unlike other solutions where pelican runs inside the container, this solution
  decouples pelican from the deployment of the blog, it's more in keeping with
  the existing fabric build targets e.g. cf_upload.

- The default container based web server is nginx, this can be changed when
  running the pelican_quickstart

- The docker-rebuild target is only created if the user requests container
  deployment during the quickstart process.

- The docker-rebuild target works transparently with docker-machine if
  desired, to allow for very fast rebuild and update of pelican sites running
  within remote containers.

- Docker must be preinstalled on the host machine for this to work
2016-08-13 14:48:49 -04:00
docs Makes DEFAULT_DATE accept string dates; fixes #1464 2016-05-24 17:22:27 +03:00
pelican A feature to allow a pelican site to be deployed inside of a container. 2016-08-13 14:48:49 -04:00
samples Merge pull request #1602 from ltiao/patch-1 2015-04-01 08:05:40 +09:00
.coveragerc [coveralls] Exclude tests from coverage 2014-06-24 22:29:36 +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 Add python 3.5 testing environment 2015-10-22 09:45:21 +02:00
bumpr.rc Match space with POSIX sed when bumping via bumpr 2015-06-14 10:12:52 -07:00
CONTRIBUTING.rst Fix description of the search bar's positon 2016-04-12 22:48:04 +02:00
dev_requirements.txt Revert dev requirement additions 2015-08-25 11:25:57 -07: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 Coveralls badge from README 2016-03-20 16:46:14 -07:00
setup.cfg Revert setup.py changes. Ensure universal wheels. 2014-07-01 14:33:04 -07:00
setup.py Bump feedgenerator version number to 1.8 #1933 2016-04-07 10:27:46 +09:00
THANKS Made name of blogroll/social widgets configurable. 2015-10-11 14:14:14 -04:00
tox.ini Do not fail tox run if coveralls push fails 2015-10-22 09:45:49 +02:00

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

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
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/pelican.svg
   :target: https://pypi.python.org/pypi/pelican
   :alt: PyPI: the Python Package Index