WP Manifestindependent plugin directory
manifest / content / wordpress-ipynb-git-bridge

Jupyter notebooks from github

WordPress plugin to import Jupyter notebooks from github into a wordpress blog. Inspired by https://github.com/gis-ops/wordpress-markdown-git but uses client-side rendering via jsvine/nbpreview

by cdalinghaus · github.com/cdalinghaus/wordpress-ipynb-git-bridge · website

★ 0stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/cdalinghaus/wordpress-ipynb-git-bridge/archive/refs/heads/main.zip
No built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.
Readme github.com/cdalinghaus/wordpress-ipynb-git-bridge ↗

wordpress-ipynb-git-bridge is a WordPress plugin for importing and syncronizing .ipynb notebooks from github into a wordpress blog post. This allows you to version control your posts via Github.

Example usage:

[ipynb https://github.com/rasbt/matplotlib-gallery/blob/master/ipynb/heatmaps.ipynb]

Notebook rendering can be previewed at https://jsvine.github.io/nbpreview/

Use a raw cell as the first cell in your notebook to set post metadata:

%META
title=This is the post title
excerpt=This is the post excerpt
tags=tutorial, python, fibonacci
categories=math,hobby

Every key is optional. Metadata will overwrite fields that were manually set in WordPress. Tags and categories will be created if they don't exist.

Features

  • Pull and synchronize ipynb notebooks from github into your WordPress blog
  • Base64 embedded images are converted to static webp
  • File system caching
  • Parse and autoload post title, excerpt, tags, categories and slug from notebook metadata cell

Planned features™

  • [ ] Somehow grab publish_date and update_date from github
  • [ ] Auto sync the repository to the blog

Known bugs (In order of importance)

  • Base64 images embedded via markdown are not turned into static media

Known caveats

  • Rendering interactive visualizations is limited, this needs more testing.
  • Cache has to be reset manually by clearing wp-content/uploads/ipynb-media/*
  • raw.githubusercontent.com caches files for 5 minutes, making manual clearing the cache after an update inconvenient
  • When images are removed from a notebook that has been optimized previously, corresponding .webp files can become orphant. Fix this by periodically clearing ipynb-media directory.
  • Titles must be unique since slugs depend on them

Built using...

Inspired by https://github.com/gis-ops/wordpress-markdown-git
Rendering done via https://github.com/jsvine/nbpreview
Notebook styling taken from https://github.com/jsvine/notebookjs
https://gist.github.com/mrbobbybryant/a18588f86b12fa71224b