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

Move markdown library out of librustdoc into it's own libmarkdown #12346

Closed
mneumann opened this issue Feb 17, 2014 · 2 comments
Closed

Move markdown library out of librustdoc into it's own libmarkdown #12346

mneumann opened this issue Feb 17, 2014 · 2 comments

Comments

@mneumann
Copy link
Contributor

Rust ships with a Markdown implementation. By moving it into it's own library, it's less hidden to the programmer and other people can depend on it for their own projects.

I know that I can use it right now via rustdoc::html::markdown::Markdown, but this also means that I depend on the whole rustdoc library, not just markdown.

I think if we ship with markdown we should make it available as a first class library for everyone to use and depend on.

@flaper87
Copy link
Contributor

I think it is a good idea to pull it out of rustdoc

@alexcrichton
Copy link
Member

As the 1.0 release is focused on the API stability of the standard library, I don't think that this is going to happen in the mainline distribution. The shipped version of libmarkdown (if we create one), will be intentionally gated off with #![experimental]. We do have a number of libraries in this situation (see the lists on #18585), as well as a theoretical strategy for dealing with how to ship them.

Times have changed since this bug was created, however, and we primarily now have Cargo. I think for now we'd have a difficult time refactoring librustdoc to extract the Markdown implementation in any sort of a usable fashion, so I'm going to close this for now because we're able to have a high-quality markdown crate in the Cargo ecosystem rather than the standard library itself.

We can certainly investigate bringing in an excellent implementation for use by rustdoc as well!

bors added a commit to rust-lang-ci/rust that referenced this issue Jul 25, 2022
… r=Veykril

fix: special case base url of `BuiltinType` to core

fix rust-lang#12250
flip1995 pushed a commit to flip1995/rust that referenced this issue Feb 26, 2024
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

3 participants