Notebook: Spec and implementation of markdown extensions

Created on 27 Apr 2017 · 5Comments · Source: jupyter/notebook

There are many issues related to extending markdown to support different elements and use cases:

And an ongoing discussion about switching to Commonmark: Related to https://github.com/jupyter/notebook/issues/1371

Let's bring these separate discussions together here and figure out a good way enable this in classic notebook, JupyterLab, nteract, nbconvert, nbviewer, etc.

cc @ellisonbg @Carreau @takluyver @rgbkrk @minrk @blink1073 @jasongrout

Notebook Needs Discussion Maintenance

Source

gnestor

👍4

Most helpful comment

I don't think we want to introduce anything that breaks existing markdown in the notebooks, but rather provides an extension point for adding support for elements (e.g. to do lists, collapsible sections, "info" and "warn" boxes, AsciiMath, mermaid) or handling non-HTTP URLs.

gnestor on 28 Apr 2017

👍2

All 5 comments

There are also many issues related to spotty mathjax/LaTeX support in markdown:

gnestor on 27 Apr 2017

Thanks for compiling this together. It's downright overwhelming to deal with all these conflicting extensions.

rgbkrk on 27 Apr 2017

this is awesome! cc'ing @mpacer

JamiesHQ on 27 Apr 2017

Awesome! Thanks for pulling all of this together.

The big challenge in all of this is that there are millions of notebooks
already written. If we change the syntax from what is supported in the
classic notebook (and lab), we will break those notebooks. Minimally, we
would need a major version change to the notebook format...

[ Another nice way of tracking lots of issues like this is to use a GitHub
project, makes it easier to track dynamic sets of issues that aren't quite
a milestone.]

On Thu, Apr 27, 2017 at 1:12 PM, JamieW notifications@github.com wrote:

this is awesome! cc'ing @mpacer https://github.com/mpacer

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/jupyter/notebook/issues/2450#issuecomment-297825999,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AABr0PWCnhBMipLiSo0DGOrEdhK1GD2gks5r0Pa4gaJpZM4NKn6f
.

--
Brian E. Granger
Associate Professor of Physics and Data Science
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
[email protected] and [email protected]