https://github.com/aeisenbarth/myst-nb-json

A MIME-type plugin for rendering JSON output from Jupyter notebooks to HTML
https://github.com/aeisenbarth/myst-nb-json

json myst myst-nb python sphinx

Last synced: about 2 months ago
JSON representation

A MIME-type plugin for rendering JSON output from Jupyter notebooks to HTML

• Host: GitHub
• URL: https://github.com/aeisenbarth/myst-nb-json
• Owner: aeisenbarth
• License: other
• Created: 2024-06-28T15:05:56.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-07-12T12:27:45.000Z (10 months ago)
• Last Synced: 2025-03-20T12:17:48.224Z (2 months ago)
• Topics: json, myst, myst-nb, python, sphinx
• Language: Python
• Homepage: https://aeisenbarth.github.io/myst-nb-json/
• Size: 1.7 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-myst - myst-nb-json - type plugin for rendering JSON output from [Jupyter] notebooks to HTML. (Tools / Documentation System Integrations)

README

        
# MyST-NB JSON

A MIME-type plugin for rendering JSON output from Jupyter notebooks to HTML

______________________________________________________________________

Outputs from Jupyter notebook code cells usually contain representations in one or multiple MIME

types (image, text…). IPython provides multiple built-in output types, but not all of them

have a representation for HTML, and fall back to a stringified version of the Python object.

This is the case for the `application/json` type:

It is nicely rendered in Jupyter because Jupyter includes a

[JSON renderer](https://github.com/jupyterlab/jupyterlab/tree/7909745d075aceb0cf1099ad53a3174e92b575ae/packages/json-extension),

but [MyST-NB](https://myst-nb.readthedocs.io) can only use IPython's built-ins which display as

``.

## Jupyter Lab

![Screenshot of json_dict in Jupyter](./docs/images/example1-jupyter.png)

## MyST-NB without plugin

![Screenshot of json_dict in HTML by MyST-NB](./docs/images/example1-myst-nb.png)

## MyST-NB with myst-nb-json plugin

![Screenshot of json_dict in HTML with myst-nb-json](./docs/images/example1-myst-nb-json.png)

## Implementation

This package requires (besides MyST-NB) no other dependencies. The front-end code is written in

plain HTML/JavaScript, avoiding heavy dependencies and built steps.