Switch to CommonMark
Open
Nobody has claimed this yet.
component:Notebook
maintenance
status:Needs Discussion
- Dominant language
- Jupyter Notebook
- Stars
- 13.3k
- Forks
- 5.8k
- Avg merge
- 6d 11h
- Merged PRs (30d)
- 7
Description
I don't know if this has been discussed yet, but I think it's high time to switch to CommonMark.
It looks like there are (at least) 2 JavaScript implementations:
The latter seems to allow syntax extensions, and there is even already a MathJax extension: https://github.com/classeur/markdown-it-mathjax
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the two proposed JavaScript implementations, commonmark.js and markdown-it, with attention to syntax extensions and the linked markdown-it MathJax extension. Determine which notebook rendering entry points and existing behavior would need review; done means the project has an agreed CommonMark implementation and a clear compatibility plan.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100