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 f21969a016 Ensure invoke lint task & its docs are in sync
Someday the entire Pelican code base will perhaps have Black and isort
formatting applied to it, but it doesn't make sense for the linter to
check that until it's actually done. This changes the `lint` Invoke task
to run Flake8 on changed lines only, which should bring it into line
with both the current Pre-commit and CI configurations.

Also, the docs erroneously stated that `invoke tests` would also check
for code style compliance, which has herein been fixed.
2020-11-20 16:22:39 +01:00
.github add python3.9 to CI 2020-10-12 18:47:08 +03:00
docs Ensure invoke lint task & its docs are in sync 2020-11-20 16:22:39 +01:00
pelican Fix plugins running twice in autoreload mode 2020-10-31 20:34:45 +08:00
requirements Count CPU cores via psutil for parallel testing 2020-11-02 13:17:53 +01: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 Add poetry.lock to list of files for Git to ignore 2020-04-12 15:21:17 +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
CONTRIBUTING.rst Prefix Pip commands with python -m in docs 2020-08-17 07:04:00 +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 MANIFEST.in include jinja2 templates 2020-08-24 22:34:02 +09:00
pyproject.toml Release Pelican 4.5.1 2020-11-02 13:15:26 +00:00
README.rst Update PyPI URLs to new equivalents 2020-11-20 15:46:05 +01:00
setup.cfg Revert setup.py changes. Ensure universal wheels. 2014-07-01 14:33:04 -07:00
setup.py Release Pelican 4.5.1 2020-11-02 13:15:26 +00:00
tasks.py Ensure invoke lint task & its docs are in sync 2020-11-20 16:22:39 +01:00
THANKS Invoke template : avoiding to spawn unnecessary process + passing-through CLI args to pelican 2020-06-09 16:01:46 +02:00
tox.ini add python3.9 to CI 2020-10-12 18:47:08 +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.org/project/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