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

markdown checkboxes not working #692

Open
devinschumacher opened this issue Oct 29, 2024 · 2 comments
Open

markdown checkboxes not working #692

devinschumacher opened this issue Oct 29, 2024 · 2 comments

Comments

@devinschumacher
Copy link

runme says it supports standard .md out of the box. but it doesnt render checkboxes. - [ ] --- what is the def. of standard markdown? theres no link in the documentation - ref: https://docs.runme.dev/usage/runme-extensions#supported-file-extensions

@sourishkrout
Copy link
Member

Repeating what was said on Discord here:

I believe, checkboxes are part of GitHub-flavor markdown which isn't actually the standard. That being said, I/we understand how widespread it is.

To answer your original question, foundational, we rely on VS Code's choices for markdown rendering:
https://code.visualstudio.com/docs/languages/markdown#_does-vs-code-support-github-flavored-markdown

it's targeting CommonMark via the markdown-it library: https://github.com/markdown-it/markdown-it

We will add this to the docs. We are keeping this ticket open to look into making checkboxes available.

@devinschumacher
Copy link
Author

devinschumacher commented Oct 29, 2024

Right on! sounds good to me... What thought i had was that as your docs say the .md and .mdx are supported, if there's flexibility on the .mdx side to render alot more things as it was created for making components in markdown i believe - reference

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

2 participants