golang / go

The Go programming language
https://go.dev
BSD 3-Clause "New" or "Revised" License
124k stars 17.67k forks source link

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

Open madkins23 opened 8 months ago

madkins23 commented 8 months ago

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.

suzmue commented 8 months ago

cc @matloob

matloob commented 8 months ago

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?

madkins23 commented 8 months ago