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

Use CommonMark instead of Markdown in sample notebooks #957

Closed
jeremiahpslewis opened this issue Feb 28, 2021 · 1 comment
Closed

Use CommonMark instead of Markdown in sample notebooks #957

jeremiahpslewis opened this issue Feb 28, 2021 · 1 comment
Labels
one day Closed because we won't work on it soon, will be opened again later.

Comments

@jeremiahpslewis
Copy link
Contributor

Problem

Julia's current markdown library has numerous unresolved issues and the heavy use of the library in Pluto.jl is creating numerous follow on issues in the Pluto.jl project for what is an integral, but unrelated dependency:

Proposed Solution

Fortunately, there is a new, nicely architected (and well-tested) library, CommonMark.jl which can be used as a (nearly) drop-in replacement in the sample notebooks (ignoring for the moment the particular use cases for Pluto.jl internals. This library is under consideration for inclusion in Julia's stdlib and forms an easier to reason about basis for making notebook computing 'simpler and more accessible'.

Note

As far as I can tell, the CommonMark is missing a macro to make strings 'just work' as markdown text. If this proposal is accepted, this macro could potentially be added to the Pluto.jl project and then eventually integrated into the CommonMark.jl package.

I have converted one notebook in a PR as an example so that you can assess the overall impact of this change.

#956

@fonsp
Copy link
Owner

fonsp commented Mar 4, 2021

Discussion continued in #956 (comment)

@fonsp fonsp added the one day Closed because we won't work on it soon, will be opened again later. label Mar 4, 2021
@fonsp fonsp closed this as completed Mar 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
one day Closed because we won't work on it soon, will be opened again later.
Projects
None yet
Development

No branches or pull requests

2 participants