pelican README

The project's README from github.com/getpelican/pelican. As one markdown file: README.md.

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

Pelican is a static site generator, written in Python_, that allows you to create web sites by composing text files in formats such as Markdown, reStructuredText, and HTML.

With Pelican, you can create web sites without worrying about databases or server-side programming. Pelican generates static sites that can be served via any web server or hosting service.

You can perform the following functions with Pelican:

Features

Pelican’s feature highlights include:

Check out the Pelican 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. For information on how it works, have 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 Plugins: https://github.com/pelican-plugins .. _Pelican 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/actions/workflow/status/getpelican/pelican/main.yml?branch=main :target: https://github.com/getpelican/pelican/actions/workflows/main.yml?query=branch%3Amain :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 .. |downloads| image:: https://img.shields.io/pypi/dm/pelican.svg :target: https://pypi.org/project/pelican/ :alt: Monthly Downloads from PyPI .. |repology| image:: https://repology.org/badge/tiny-repos/pelican.svg :target: https://repology.org/project/pelican/versions :alt: Repology: the packaging hub

pelican (getpelican/pelican)

Searching Database…

13.4K ·GitHub
What is this?Pelican is a static site generator written in Python that turns text files in Markdown, reStructuredText, or HTML into complete web sites.
Is this a library I import or a standalone tool?It's a command-line tool: you write content files and run a CLI command that regenerates HTML, CSS, and JS from them.
How do I get a site running with it?Install it via pip, write your posts and pages in Markdown or reST, then run the Pelican command-line tool to generate the static output, which you can host on any web server.
Do I need a database or server-side code to use it?No, Pelican explicitly removes that need since it produces completely static output.
Does it come with themes and plugins out of the box?It includes Jinja2-based site themes and supports an external plugin ecosystem, but README doesn't detail which themes ship by default versus need to be added.
Can I migrate an existing blog into Pelican?Yes, it can import existing content from WordPress, Dotclear, or RSS feeds.
Does it support multilingual sites and feeds?Yes, it can publish articles in multiple languages and generates Atom and RSS feeds.
Does Pelican rebuild fast on large sites?It uses content caching and selective output writing for fast rebuild times.
Where does the name Pelican come from?Pelican is an anagram of 'calepin', the French word for notebook.
Creator
getpelican
Size
7.7 MB
Stars
13.4K
Age
16y
Commits · 90 Days