Note: I wrote this code a long time ago and have not used it for years. https://github.com/klane/jekyllnb is probably better in 2023.

nbconvert_jekyll

This extension for Jupyter nbconvert is useful when you manage a blog with Jekyll (for example on Github pages).

• It uses some metadata fields of the notebook (you can change them under "Edit" > "Edit Notebook Metadata") to fill the YAML frontmatter of Jekyll:
  • If 'title' is defined, it is used for the 'title' field. You may have some issues if the title contains double quotation marks ("). It also changes the html title of the page.
  • If 'date' is defined, it is used for the 'date' field for Jekyll. As writted in the doc: "A date is specified in the format YYYY-MM-DD HH:MM:SS +/-TTTT; hours, minutes, seconds, and timezone offset are optional.".
• It adds a Liquid template (the templating system used by Jekyll) for Google Analytics that is activated if you define google_analytics in _config.yml (it works like that in the Github Themes).

Installation

pip install --upgrade git+https://github.com/louisabraham/nbconvert_jekyll

How to use

jupyter nbconvert file.ipynb --to jekyll