Static site generator that supports Markdown and reST syntax. Powered by Python.
  • Python 85.3%
  • CSS 8.7%
  • Jinja 6%
Find a file
Peter Sabaini 34edcdf33d Override settings from the commandline
Add a --setting-overrides KEY=VAL commandline option to override
arbitrary items from pelicanconf.py settings files. This adds
flexibility in running pelican and helps reduce sprawl of settings
files. Cast int and str setting overrides to their respective types. Support other setting types by treating them as json. Fallback to json when an override typecast errors. This should make it
possible to set int values to None, resp. to json 'none'
2020-05-15 18:33:56 +02:00
.github Modify tox envs to simplify CI and add Python 3.8 2020-05-09 16:17:13 +03:00
docs Cleanup test environment and requirements 2020-05-09 16:17:14 +03:00
pelican Override settings from the commandline 2020-05-15 18:33:56 +02:00
requirements Cleanup test environment and requirements 2020-05-09 16:17:14 +03:00
samples Modernize code base to Python 3+ syntax 2020-04-27 09:45:31 +02:00
.coveragerc [coveralls] Exclude tests from coverage 2014-06-24 22:29:36 +01:00
.editorconfig Add initial EditorConfig configuration 2019-11-09 08:37:54 -08:00
.gitattributes Add missing .gitattributes attributes. Refs #2069 2016-12-23 08:03:57 -08:00
.gitignore Override settings from the commandline 2020-05-15 18:33:56 +02:00
.mailmap .mailmap: Add mappings to consolidate author names and emails 2013-04-12 10:51:48 -04:00
.pre-commit-config.yaml Only run Flake8 on changed lines 2020-04-30 21:43:31 +02:00
.travis.yml Modify tox envs to simplify CI and add Python 3.8 2020-05-09 16:17:13 +03:00
CONTRIBUTING.rst Relax hard/enforced line length to 88 characters 2020-04-27 09:45:30 +02:00
LICENSE Update links to HTTPS and current 301 redirects in docs/templates/themes (#2661) 2020-04-12 16:38:35 +02:00
MANIFEST.in Add pyproject.toml to MANIFEST.in 2019-07-14 17:09:11 +02:00
pyproject.toml Add dev dependencies expected by tasks.py 2020-04-24 14:48:34 +02:00
README.rst Switch README CI badge from Travis to GitHub Actions 2020-05-10 08:11:00 +02:00
setup.cfg Revert setup.py changes. Ensure universal wheels. 2014-07-01 14:33:04 -07:00
setup.py Modernize code base to Python 3+ syntax 2020-04-27 09:45:31 +02:00
tasks.py Cleanup test environment and requirements 2020-05-09 16:17:14 +03:00
THANKS Initial pass of removing Python 2 support 2019-11-26 06:16:41 +09:00
tox.ini Cleanup test environment and requirements 2020-05-09 16:17:14 +03:00

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

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: https://palletsprojects.com/p/jinja/
.. _Pygments: https://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/github/workflow/status/getpelican/pelican/build
   :target: https://github.com/getpelican/pelican/actions
   :alt: GitHub Actions 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
.. |repology| image:: https://repology.org/badge/tiny-repos/pelican.svg
   :target: https://repology.org/project/pelican/versions
   :alt: Repology: the packaging hub