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

Add support for using markdown-it instead of marked #314

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

danishcake
Copy link

markdown-it is the markdown parser used by Visual Studio Code, so using it grants access to a rich ecosystem of plugins.

resolves #313

markdown-it is the markdown parser used by Visual Studio Code, so using it
grants access to a rich ecosystem of plugins.
@danishcake
Copy link
Author

Found that the id tags created for headers differed from those created by marked, which might catch people out, if they expect markdown-it to be a drop-in replacement.

This should be fixed

@simonhaenisch
Copy link
Owner

Wow thanks a lot for this! Spending a month in New Zealand so I was traveling for the last few days... I'll try to go through it this week or next. Also still need to update marked like 10 major versions 😅

Regarding header IDs I would say let's stick with the markdown-it default even if it differs from marked, and rather add a note in the readme that they are different (and add the config instructions for changing it to make it the same as marked).

@danishcake
Copy link
Author

To be clear before I start wading into the code base: We want the default markdown-it behaviour, which is to not assign header IDs at all. If so, that's fair.

Enjoy New Zealand - here in the UK it's raining non-stop.

@simonhaenisch
Copy link
Owner

Sry I haven't had any time to review this yet. I haven't forgotten about it though 🙃

@simonhaenisch
Copy link
Owner

Hey @danishcake sry it's been so long, i started reviewing it today! (looks good so far, thanks ❤️)

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

Successfully merging this pull request may close these issues.

feature: Allow use of markdown-it as the markdown parser
2 participants