Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
bollwyvl opened this issue Mar 14, 2023 · 2 comments · May be fixed by #101
Closed

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

bollwyvl opened this issue Mar 14, 2023 · 2 comments · May be fixed by #101

Comments

@bollwyvl
Copy link

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
```
@krassowski
Copy link
Member

The associated JEP is #101

@gabalafou
Copy link
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
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants