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

Change markdown parser #2614

Open
restuccia opened this issue May 26, 2021 · 4 comments
Open

Change markdown parser #2614

restuccia opened this issue May 26, 2021 · 4 comments

Comments

@restuccia
Copy link
Contributor

Currently udata parses markdown according to the the "original" spec by John Gruber

This implies some ambiguities, as pointed out in the GFM spec here, and lacks some potentially cool features such as tables.

In order to solve the aforementioned ambiguities and implement cool stuff such as better static pages, improved dataset descriptions, etc., I propose a migration towards GitHub Flavoured Markdown (GFM) github/cmark-gfm (spec here)

@taniki
Copy link
Contributor

taniki commented May 26, 2021

#2341 we might be are already parsing using GFM as a standard

@gmougeolle
Copy link
Contributor

gmougeolle commented May 26, 2021

I can confirm that, just tested one example (n°198) from the GFM spec and it does render a table in a post article

@restuccia
Copy link
Contributor Author

Then why on the (old version of the) inventory page on machine learning, lists were not rendered correctly ?

Capture d’écran 2021-05-26 à 17 01 55

@gmougeolle
Copy link
Contributor

Do you mean that what you see on the backend is different from what is rendered on the front-end ? I don't have access to the production backend

I know that there are at least two markdown parsers, that might be the reason you're seeing a difference.
As to why the front-end parser doesn't understand this list, it might be that its GFM implementation is wrong or incomplete.

However it does support tables ! ✨
I can't really help further but thanks to you I'll be styling the tables for the redesigned version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants