What Markdown dialect does Typst Universe use? Is it possible to specify the size of images in my package's README?

I just updated a package of mine and added a rendered version of an example as png to the README using [...](...) Markdown syntax. The png is stretched to the container width, which on Desktop means that the font is very large but only a part of the example fits on the screen. I want to avoid adding a “letterbox” as that would reduce size on small screens.

Is there a way to specify the (maximum) width of an image included in the README that Universe would understand? More generally, what Markdown dialect does Universe use/what features does it support?

3 Likes

Did you ever get an answer to this?

I stumbled into the same question due to failing linter checks in a merge request of a package I use (actually it’s yours @quachpas :smile:).

The check runs typst/package-check and the README is checked here.
In my understanding (at least in the check) Comrak is used.

There seems to be an option to enable GitHub flavored md, but it seems to not be enabled…

2 Likes