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 216eec50fc Add pyproject.toml and poetry.lock to project
This could facilitate publishing new versions of Pelican as well as make
it easier for Poetry users to install Pelican via: `poetry install`

Closes #2450
2019-06-28 17:44:42 +02:00
.github Add FUNDING.yml to project 2019-06-17 15:36:07 +02:00
docs Update livereload Invoke task and add docs 2019-06-18 22:59:34 -04:00
pelican Add theme templates, CSS, JS to Invoke livereload task 2019-06-20 08:30:04 +02:00
requirements Pin Python-Markdown to >= 3.1 in test requirements 2019-06-10 21:12:12 +02:00
samples Convert FEED settings from %s to {slug} redux (#2432) 2018-11-03 16:12:20 +01: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 Add Python 3.5 env back to Travis tests. Refs #2571 2019-06-24 20:21:19 +02:00
bumpr.rc Match space with POSIX sed when bumping via bumpr 2015-06-14 10:12:52 -07:00
CONTRIBUTING.rst Update http:// links to https:// where appropriate 2019-04-25 15:08:04 +02:00
LICENSE Include the complete license rather than the short version. See #103 2011-04-26 13:46:02 +01:00
MANIFEST.in Remove *.in files from MANIFEST.in 2018-08-03 14:57:22 +02:00
poetry.lock Add pyproject.toml and poetry.lock to project 2019-06-28 17:44:42 +02:00
pyproject.toml Add pyproject.toml and poetry.lock to project 2019-06-28 17:44:42 +02:00
README.rst Update http:// links to https:// where appropriate 2019-04-25 15:08:04 +02:00
setup.cfg Revert setup.py changes. Ensure universal wheels. 2014-07-01 14:33:04 -07:00
setup.py Update livereload Invoke task and add docs 2019-06-18 22:59:34 -04:00
THANKS Update http:// links to https:// where appropriate 2019-04-25 15:08:04 +02:00
tox.ini Update Tox config and fix failing CI envs 2019-06-18 22:44:46 -04: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: https://www.python.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Markdown: https://daringfireball.net/projects/markdown/
.. _Jinja2: http://jinja.pocoo.org/
.. _Pygments: http://pygments.org/
.. _`Pelican's documentation`: https://docs.getpelican.com/
.. _`Pelican's internals`: https://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