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

x/pkgsite: add support for github's markdown footnotes #65922

Open
madkins23 opened this issue Feb 24, 2024 · 3 comments
Open

x/pkgsite: add support for github's markdown footnotes #65922

madkins23 opened this issue Feb 24, 2024 · 3 comments

Comments

@madkins23
Copy link

madkins23 commented Feb 24, 2024

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/madkins23/go-slog@v0.8.3-alpha-server/infra#section-readme

What is your user agent?

Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36

Screenshot

Github:
github-footnote

pkg.go.dev:
no-footnotes

What did you do?

Added footnotes to README.md file per Github markdown syntax.

What did you see happen?

Works fine in Github. Footnotes not respected in pkg.go.dev.

What did you expect to see?

Footnotes should look the same in both places if possible.

@gopherbot gopherbot added this to the Unreleased milestone Feb 24, 2024
@Jorropo Jorropo changed the title x/pkgsite: issue title x/pkgsite: add support for github's markdown footnotes Feb 24, 2024
@suzmue suzmue modified the milestones: Unreleased, pkgsite/backlog Feb 26, 2024
@suzmue
Copy link
Contributor

suzmue commented Feb 29, 2024

cc @matloob

@matloob
Copy link
Contributor

matloob commented Feb 29, 2024

This is interesting. footnotes don't seem to be mentioned in the github flavored markdown spec here: https://github.github.com/gfm/. Could you link us to official documentation of footnotes in github?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants