Is it possible to preview whether README.md is rendered as expected before publishing the crate on crates.io?

help
1

For example, :crab: is rendered as :crab: on GitHub, but not in crates.io according to the following discussion.

I would like to know issues like this before publishing the crate. However, I only know how to check the rendering result of README.md after publishing the crate.

Is it possible to check this in advance and how can this be achieved?

1 Like
2

You can find how crates.io renders markdown here. Other than executing it locally or in CI yourself and inspecting the generated html, I don't think there is a way to pre-inspect what crates.io generates.

2 Likes