pelican  4.8.0
About: Pelican is a static site generator that supports Markdown and reStructuredText (reST) syntax (written in Python).
  Fossies Dox: pelican-4.8.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  
pelican Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies pelican-4.8.0.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.rst

Pelican GitHub Actions CI: continuous integration status PyPI: the Python Package Index Repology: the packaging hub

Pelican is a static site generator, written in Python.

  • Compose content in Markdown or reStructuredText using your editor of choice
  • Simple command-line tool (re)generates HTML, CSS, and JS from your source content
  • Easy to interface with version control systems and web hooks
  • Completely static output is simple to host anywhere

Features

Pelican’s feature highlights include:

  • Chronological content (e.g., articles, blog posts) as well as static pages
  • Integration with external services
  • Site themes (created using Jinja2 templates)
  • Publication of articles in multiple languages
  • Generation of Atom and RSS feeds
  • Code syntax highlighting via Pygments
  • Import existing content from WordPress, Dotclear, or RSS feeds
  • Fast rebuild times due to content caching and selective output writing
  • Extensible via a rich plugin ecosystem: Pelican Plugins

Check out the Pelican documentation for further information.

How to get help, contribute, or provide feedback

See our contribution submission and feedback guidelines.

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.