Enable footnotes for README.md files
@BGR360 is already working on this.
Since Dec 1, 2022.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
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 markdown[^1], is it now possible to add this feature to the docs?
[^1]:https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/
This mostly involves enabling in Comrak, where they're already supported.
Originally posted by @zStruCat in https://github.com/rust-lang/docs.rs/issues/117#issuecomment-1147559768
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.