Skip to content

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

Closed
@bollwyvl

Description

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:

SPOILERS

The proposed implementation is mermaidjs 10.

The proposed syntax is the one implemented in the most places, based on GitHub fenced code blocks:

```mermaid
flowchart LR
    chicken --> egg --> chicken
```

Activity

krassowski

krassowski commented on Apr 15, 2023

@krassowski
Member

The associated JEP is #101

gabalafou

gabalafou commented on Jun 3, 2024

@gabalafou
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Participants

    @bollwyvl@gabalafou@krassowski

    Issue actions

      Pre-proposal: Adopting a text-based diagram syntax in Jupyter Markdown · Issue #100 · jupyter/enhancement-proposals