Skip to content

Use comrak instead of hoedown #117

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

Merged
merged 1 commit into from
Apr 11, 2017
Merged

Use comrak instead of hoedown #117

merged 1 commit into from
Apr 11, 2017

Conversation

kivikakk
Copy link
Contributor

Fixes #53.

There's an actual missing feature still, looking at this diff — footnotes. Do you know if these are actually used in Markdown files parsed by docs.rs? They're not supported by GitHub's own README.md renderer, for what it's worth.

@kivikakk
Copy link
Contributor Author

And a screenshot comparison (from the example package on #53):

Before After
screen shot 2017-04-11 at 8 40 58 pm screen shot 2017-04-11 at 8 41 01 pm

@onur onur merged commit a32ff6e into rust-lang:master Apr 11, 2017
@onur
Copy link
Member

onur commented Apr 11, 2017

This is great, and thank you very much for all your troubles!

@kivikakk kivikakk deleted the commonmark branch April 11, 2017 11:19
@kivikakk
Copy link
Contributor Author

Thank you! Let me know if you have any trouble or anything with it, I'd be happy to help. :)

@zStruCat
Copy link

zStruCat commented Jun 6, 2022

There's an actual missing feature still, looking at this diff — footnotes. Do you know if these are actually used in Markdown files parsed by docs.rs? They're not supported by GitHub's own README.md renderer, for what it's worth.

Footnotes are now a part of github-favored markdown1, is it now possible to add this feature to the docs?

Footnotes

  1. https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/

@kivikakk
Copy link
Contributor Author

kivikakk commented Jun 6, 2022

Indeed, they've since been added to Comrak too (to match cmark-gfm; kivikakk/comrak#42), so it shouldn't be hard.

@jyn514
Copy link
Member

jyn514 commented Jun 7, 2022

Footnotes are now a part of github-favored markdown1, is it now possible to add this feature to the docs?

I'm happy to review PRs enabling the feature :) not sure when I'll have time to work on it myself.

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

Successfully merging this pull request may close these issues.

Github-flavored markdown support
4 participants