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

Switch to a different markdown parser #537

Open
rubenwardy opened this issue Jun 7, 2024 · 0 comments
Open

Switch to a different markdown parser #537

rubenwardy opened this issue Jun 7, 2024 · 0 comments

Comments

@rubenwardy
Copy link
Member

Problem

ContentDB currently uses python markdown, which aims to implement markdown exactly as written in the original document. This causes a lot of confusion with users, as most sites use a less strict version of Markdown such as GitHub Flavored Markdown or Common Markdown. For example, one error that catches users out is that blank lines are required around blocks (paragraphs, lists, code blocks, etc)

Solutions

Switch to a less strict markdown parser, such as GitHub Flavored Markdown or Common Mark

Will need to test with existing packages to make sure that breakages aren't too severe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Back log
Development

No branches or pull requests

1 participant