search

stateful / runme

DevOps Notebooks Built with Markdown
https://runme.dev
Apache License 2.0
1.16k stars 38 forks source link

markdown checkboxes not working #692

Open devinschumacher opened 3 days ago

devinschumacher commented 3 days ago

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 commented 3 days ago

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 commented 3 days ago

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