Notebook: Feature Request: Enhanced Markdown Support For Graphs

Created on 16 Mar 2017  路  4Comments  路  Source: jupyter/notebook

Dear Jupyter-Notebook-Team,

I just got to know an awesome atom markdown extension which includes many useful graphing tools not available yet in jupyter-notebook markdown (at least to my knowledge):

[copied from https://github.com/shd101wyy/markdown-preview-enhanced/blob/master/README.md]

  • mermaid to render flowchart and sequence diagram.

    • code block with mermaid (or @mermaid) notation will be rendered by mermaid

    • check mermaid doc for more information about how to create flowchart and sequence diagram

    • mermaid

  • PlantUML to create multiple kinds of graph. (Java is required)

    • code block with puml or plantuml or (@puml or @plantuml) notation will be rendered by PlantUML.

  • Viz.js to render dot language graph.

    • code block with viz (or @viz) notation will be rendered by Viz.js.

    • add engine:[engine_name] at the first line of code block to choose different render engine. For example engine:dot. Engine circo, dot, neato, osage, or twopi are supported. Default engine is dot.

  • WaveDrom to create digital timing diagram.

    • code block with wavedrom (or @wavedrom) notation will be rendered by wavedrom.

I adapted the order to match my personal prioritized wish list.

Questions:

  • Any plans to include such features?
  • Maybe it is possible to create some nbextensions dealing with these features separately? Hints / suggestions how to do this?

Most helpful comment

Yeah, this is actually a good add-on if we have it, do we have it yet?

All 4 comments

The JupyterLab project may allow the markdown renderer to be replaced with a custom plugin, so this could be implemented as a custom plugin on top of JupyterLab.

so this is not possible at the moment by implementing a respective nbextension?

Been definitely looking for something like this for a while now.
Could be hacked with a Graphviz dependency using something like this: https://github.com/jawher/markdown-dot

Though that mermaid does look sweet.

Yeah, this is actually a good add-on if we have it, do we have it yet?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

md-jamal picture md-jamal  路  3Comments

cancan101 picture cancan101  路  3Comments

mikepqr picture mikepqr  路  3Comments

fonnesbeck picture fonnesbeck  路  3Comments

jonatanblue picture jonatanblue  路  3Comments