-
Notifications
You must be signed in to change notification settings - Fork 643
Allow & render markdown for the description #165
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
Comments
Markdown usually requires a double space for a new paragraph, so if we were to do that, this would still end up looking like this, as a note... |
In reality my Cargo.toml has better spacing. For some reason the extra lines seem to have been eaten by github when I copy-pasted it here. |
Currently we don't allow markdown for various security concerns, but if we could mitigate those then we would just use a normal markdown parser. |
What about a simple Markdown parser that, to start with, only formats italic, bold, I'm not sure how to go about it, but it's one of the things I wanted to work on eventually for experience |
Links and lists are probably also a good idea |
This is fixed by #869? |
It seems like the goal was for the page on crates.io to have a nicely-formatted info section, which is achieved by rendering the readme |
What @anthonynguyen said. |
I think there's still value in having (limited) markdown in the description, similar to what's supported in the README. See https://crates.io/crates/tide-tracing for an example, where it'd be nice to have those links get rendered as links wherever the description appears. |
I tried to write a nice description in my Cargo.toml:
But on crates.io the white spaces and line breaks are ignored, leading to an ugly mess: https://crates.io/crates/glium
In my opinion it would be nice to add a
<pre>
around or something.The text was updated successfully, but these errors were encountered: