Pelican Jupyter

Overview

This is a product analysis of the Pelican-Jupyter plugin. The author mentions that they have not used the project themselves in a long time and that no issues or PRs can be created. They recommend using mkdocs and their mkdocs-jupyter plugin instead.

Features

• Provides two modes for using Jupyter notebooks in Pelican: Markup mode and Liquid tag mode.
• Markup mode allows .ipynb files to be recognized as a valid filetype for an article.
• Liquid tag mode allows notebooks to be included in a regular post using Markdown.
• Provides flexibility to combine existing notebook code or output with extra text in Markdown.
• Can generate a summary for the article automatically in Markup mode.
• Can use both modes at the same time.

Markup Mode

On your pelicanconf.py:

# Add plugin to Pelican
PLUGINS = [
    # ...
    'pelican_jupyter'
    # ...
]

Option 1: .nbdata metadata file

• Place the .ipynb file in the content folder and create a new file with the same name as the ipython notebook with extension .nbdata.
• The .nbdata file should contain the metadata like a regular Markdown based article.

Option 2: Metadata cell in notebook

• The metadata is extracted from the first cell of the notebook (which should be a Markdown cell) and is then ignored when the notebook is rendered.

Liquid Tag Mode

On your pelicanconf.py:

# Add plugin to Pelican
PLUGINS = [
    # ...
    'pelican_jupyter.liquid'
    # ...
]

Summary

The Pelican-Jupyter plugin allows users to incorporate Jupyter notebooks into their Pelican articles. It provides two modes, Markup mode and Liquid tag mode, which offer flexibility in how notebooks are included. The plugin supports both the latest versions of Pelican and Jupyter as well as older versions. Users can choose to include the notebook metadata using either a separate .nbdata file or a metadata cell in the notebook itself. Overall, the plugin provides a convenient way to integrate Jupyter notebooks into Pelican articles.