Important note: We are in the process of migrating plugins from this monolithic repository to their own individual repositories under the new Pelican Plugins organization, a place for plugin authors to collaborate more broadly with Pelican maintainers and other members of the community. The intention is for all the plugins under the new organization to be in the new “namespace plugin” format, which means these plugins can easily be Pip-installed and recognized immediately by Pelican 4.5+ — without having to explicitly enable them.
This transition process will take some time, so we appreciate your patience in the interim. If you would like to help speed up this transition, the following would be very helpful:
- If you find a plugin here that has not yet been migrated to the new organization, create a new issue under this repository and communicate which plugin you would like to help migrate, after which a Pelican maintainer will guide you through the process.
- If you have come here to submit a pull request to add your plugin, please consider instead moving your plugin under the Pelican Plugins organization. To get started, create a new issue under this repository with the details of your plugin, after which a Pelican maintainer will guide you through the process.
Whether you are creating a new plugin or migrating an existing plugin, please use the provided Cookiecutter template to generate a scaffolded namespace plugin that conforms to community conventions. Have a look at the Simple Footnotes repository to see an example of a migrated plugin.
The rest of the information below is relevant for legacy plugins but not for the new namespace plugins found at the Pelican Plugins organization.
The easiest way to install and use these plugins is to clone this repo:
git clone --recursive https://github.com/getpelican/pelican-plugins
and activate the ones you want in your settings file:
PLUGIN_PATHS = ['path/to/pelican-plugins']
PLUGINS = ['assets', 'sitemap', 'gravatar']
PLUGIN_PATHS
can be a path relative to your settings file or an absolute path.
Alternatively, if plugins are in an importable path, you can omit PLUGIN_PATHS
and list them:
PLUGINS = ['assets', 'sitemap', 'gravatar']
or you can import
the plugin directly and give that:
import my_plugin
PLUGINS = [my_plugin, 'assets']
Migration status:
- (blank): Local hosted plugin is still waiting for migration work.
⚠️ : Deprecated. Can be safely removed from this repository.- ❓: Externally maintained plugins that do not need explicit migration from the mono-repo. Migration work need to happen in the original owners' repo.
- ✔ : Repository has been migrated to Pelican Plugins organization.
Plugin | ℹ️ | Description |
---|---|---|
Ace Editor |
Replace default <code> by an Ace code editor with settings configure on pelicanconf.py.
|
|
Asset management |
|
|
Backref Translate |
Add a new attribute ( |
|
Better code samples |
Wraps
|
|
bootstrapify |
Automatically add bootstraps default classes to your content
|
|
Category Order |
Order categories (and tags) by the number of articles in that category (or tag). |
|
CJK auto spacing |
Inserts spaces between Chinese/Japanese/Korean characters and English words
|
|
Dead Links |
Manage dead links (website not available, errors such as 403, 404)
|
|
Encrypt content |
Password protect pages and articles
|
|
|
||
Figure References |
Provides a system to number and references figures
|
|
GA Page View |
Display Google Analytics page views on individual articles and pages
|
|
Gravatar |
|
|
Image Process |
|
|
Jinja2 Content |
|
|
Just table |
Allows you to easily create and manage tables. You can embed the tables into posts with a simple way. |
|
Libravatar |
|
|
Lightbox |
A pure CSS lightbox for Pelican.
|
|
Liquid-style tags |
|
|
Load CSV |
Adds |
|
Markdown-metaYAML |
Pelican reader to enable YAML-style metadata in markdown articles
|
|
More Categories |
|
|
Multi Neighbors |
Adds a list of newer articles and a list of older articles to every article's context. |
|
|
||
MultiMarkdown reader |
A MultiMarkdown reader. |
|
Neighbor articles Pandoc Org Reader Pandoc reader |
|
|
Panorama |
Creates charts from posts metadata |
|
PDF Images |
If an img tag contains a PDF, EPS or PS file as a source, this plugin generates a PNG preview which will then act as a link to the original file. |
|
PDF Generator |
|
|
Pelican Cite |
Produces inline citations and a bibliography in articles and pages, using a BibTeX file. |
|
pelican-ert |
Allows you to add estimated reading time of an article |
|
Pelican-flickr |
Brings your Flickr photos & sets into your static website |
|
Pelican Genealogy |
Add surnames and people so metadata and context can be accessed from within a theme to provide surname and person pages |
|
Pelican Gist tag |
Easily embed GitHub Gists in your Pelican articles |
|
Pelican Github Projects |
Embed a list of your public GitHub projects in your pages |
|
Jupyter Notebooks |
Provides two modes to use Jupyter notebooks in Pelican. |
|
Pelican Jinja2Content |
|
|
Lang Category |
Make languages behave the same as categories (visitor can browse articles in certain language). |
|
Pelican Link Class |
|
|
Pelican Mbox Reader |
Generate articles automatically via email, given a path to a Unix mbox |
|
Pelican Open graph |
Generates Open Graph tags for your articles |
|
Pelican Page Hierarchy |
Creates a URL hierarchy for pages that matches the filesystem hierarchy of their sources |
|
Pelican Page Order |
Adds a
|
|
pelican-toc |
Generates a Table of Contents and make it available to the theme via article.toc |
|
Version Generator |
A simple version generator which generates an incremented version file.
|
|
pelican_javascript |
Allows you to embed Javascript and CSS files into individual articles |
|
Pelican Meetup Info |
Include your Meetup.com group and event information on generated pages and articles
|
|
Pelican Vimeo |
Enables you to embed Vimeo videos in your pages and articles |
|
Pelican YouTube |
Enables you to embed YouTube videos in your pages and articles |
|
pelicanfly |
Lets you type things like |
|
Pelican Themes Generator |
Generates theme screenshots from the Pelican Themes repository
|
|
|
||
Pin to top |
Pin Pelican's article(s) to top "Sticky article"
|
|
Post Revision |
Extract article and page revision information from Git commit history
|
|
Read More link |
|
|
Related posts |
|
|
Render Math |
|
|
Replacer |
Replace a text of a generated HTML
|
|
Series |
|
|
Share post |
|
|
Show Source |
|
|
Similar Posts |
|
|
Simple footnotes |
|
|
Sitemap |
|
|
Tag Cloud |
|
|
Thumbnailer |
|
|
Webring |
|
Please refer to the Readme
file in a plugin's folder for detailed information about that plugin.
Please refer to the Contributing file.