Skip to content

Add Gitlab Flavored Markdown Support for Jupyter Notebook Renders

Release notes

Added Gitlab Flavored Markdown support to Jupyter Notebook Previews

Problem to solve

I like to use Jupyter Notebooks with Markdown Output. I'd like to be able to share the outputs of my notebooks without having to install additional libraries. Imagine doing a formatted string that generates the codefence for a mermaid diagram rather than using matplotlib. This would allow a notebook to be very simple. The alterantive I have now is outputting a separate markdown file to share results, but I'd rather have the code and results visible in one file.  

Proposal

Extend the Gitlab Flavored Markdown to a Notebook's output cell.

If I create an output using from IPython.display import Markdown then I suspect that...

from IPython.display import Markdown

Markdown(
f"""
### GitLab

\```mermaid
---
title: Node
---
flowchart LR
    id
\```
""")

Would result in an output cell with a mermaid node. Instead I get...

image

Submitting as a Feature Request as there's no promise of this functionality in the docs.

Intended users

All

Feature Usage Metrics

Not sure

Does this feature require an audit event?

No