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

Support commonly used markdown extensions #71183

Closed
3 tasks done
AlexApps99 opened this issue Apr 16, 2020 · 5 comments · Fixed by #81766
Closed
3 tasks done

Support commonly used markdown extensions #71183

AlexApps99 opened this issue Apr 16, 2020 · 5 comments · Fixed by #81766
Labels
A-markdown-parsing Area: Markdown parsing for doc-comments C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@AlexApps99
Copy link
Contributor

AlexApps99 commented Apr 16, 2020

These include:

The reasoning for all of these extensions is that they all have wide use not just in GitHub, but in many applications of Markdown.

@joshtriplett joshtriplett added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 16, 2020
@joshtriplett
Copy link
Member

joshtriplett commented Apr 16, 2020

I'm not sure if automatically creating http:// links from bare domain names is a good idea, so if there's an option to disable that specifically I'd suggest it. The rest all seems fine to me.

@jonas-schievink jonas-schievink added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Apr 16, 2020
@GuillaumeGomez
Copy link
Member

Just like @joshtriplett said for Autolinks. I'm also not sure to see the point of the task list one. However, adding strikethrough would be nice.

@AlexApps99
Copy link
Contributor Author

AlexApps99 commented Apr 16, 2020

Tasklist would be useful for things like this:

Currently implemented:

  • Implemented thing
  • Some other implemented thing
  • Unimplemented thing
  • Some other unimplemented thing

or possibly in the crate root

Supported features

  • Webhooks
  • Websockets
  • Websites
  • Other

@AlexApps99
Copy link
Contributor Author

AlexApps99 commented Apr 16, 2020

Another noteworthy extension to implement is Disallowed Raw HTML.
This would prevent the following tags from being used for safety reasons:

  • <title>
  • <textarea>
  • <style>
  • <xmp>
  • <iframe>
  • <noembed>
  • <noframes>
  • <script>
  • <plaintext>

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 11, 2020
…Gomez

Add strikethrough support to rustdoc

Implements uncontroversial part of rust-lang#71183.
r? @GuillaumeGomez
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 12, 2020
…Gomez

Add strikethrough support to rustdoc

Implements uncontroversial part of rust-lang#71183.
r? @GuillaumeGomez
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 12, 2020
…Gomez

Add strikethrough support to rustdoc

Implements uncontroversial part of rust-lang#71183.
r? @GuillaumeGomez
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue May 12, 2020
…Gomez

Add strikethrough support to rustdoc

Implements uncontroversial part of rust-lang#71183.
r? @GuillaumeGomez
@jyn514 jyn514 added the A-markdown-parsing Area: Markdown parsing for doc-comments label Nov 12, 2020
@jyn514
Copy link
Member

jyn514 commented Nov 12, 2020

Autolinks

We decided in #77501 not to add this. Instead rustdoc will now suggest to turn raw links into automatic links (<http://example.com>).

So I think the only thing left is adding task list parsing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-markdown-parsing Area: Markdown parsing for doc-comments C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants