Pre-proposal: Adopting a text-based diagram syntax in Jupyter Markdown

[bollwyvl]

Elevator Pitch

Jupyter Markdown should adopt a text-based syntax for building diagrams. Flagship Jupyter tools like JupyterLab 4, Jupyter Notebook 7, nbconvert, and nbviewer should render this syntax consistently.

Scope of proposal

The proposal will evaluate the merits of (in no particular order):

• portability to other Markdown-generating and -consuming platforms
• maturity of the implementation
• accessibility
• security
• performance
• maintenance/dependency burden
• breadth of diagrams and expressive power

Prior Art

Some links to existing work that will inform the proposal:

• https://github.com/jupyterlab/jupyterlab/pull/14102
• https://github.com/jupyter/nbconvert/pull/1957
• https://github.com/jupyter/software-steering-council-team-compass/issues/1

SPOILERS

The proposed implementation is [mermaidjs 10](https://mermaid.js.org/). The proposed syntax is the one implemented in the most places, based on GitHub fenced code blocks: ```mermaid flowchart LR chicken --> egg --> chicken ```

[krassowski]

The associated JEP is https://github.com/jupyter/enhancement-proposals/pull/101

[gabalafou]

As part of triage in working call today, closing this as it has an associated JEP (#101).