jupyter / jupyter/notebook

Markdown tables not strict about syntax

Open
#3,453 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
13.3k
Forks
5.8k
Avg merge
6d 11h
Merged PRs (30d)
7

Description

Markdown cells seem to properly generate tables, even when the markdown syntax is wrong; this causes issues for example, when converting a notebook to markdown and viewing it on something like GitHub.

```
a | b | c | d
--- | --- | -- |
1 | 2 | 3 | 4
```

Produces the following in a Markdown cell:

![image](https://user-images.githubusercontent.com/8518288/37718506-d63ae02a-2cf0-11e8-83ab-8a733de1738e.png)

And gets rendered on Github as:

![image](https://user-images.githubusercontent.com/8518288/37718595-10a37646-2cf1-11e8-9c9c-c3437f35c4f3.png)

Contributor guide

Open the contributing guide

Research direction

Start with the malformed Markdown table example in the issue and compare how the Markdown cell renders it with how GitHub renders the converted Markdown. Done means invalid table syntax is not accepted as a valid table, with the notebook-to-Markdown result matching strict Markdown behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, markdown
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.