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

Links broken when reading md on github #4

Open
JoshOrndorff opened this issue Aug 7, 2019 · 1 comment
Open

Links broken when reading md on github #4

JoshOrndorff opened this issue Aug 7, 2019 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@JoshOrndorff
Copy link

Many links like the ones that say "later chapters" in https://github.com/ambientsprotocol/whitepaper/blob/master/04-protocol-overview.md#ambients-protocol-summary work correctly in the pdf, but not when reading markdown online.

The problem is that the heading that are being linked to are assumed to exist in the same file, but in fact they are in separate files.

Maybe this is intended/accepted behaviour in which case you can just close this. Just wanted to point it out as it confused me while I was reading.

@haadcode
Copy link
Contributor

haadcode commented Aug 7, 2019

Thanks for pointing this out @JoshOrndorff! Totally valid and it'd be good to fix them 👍

The reason they're broken is, when reading individual md files, that we assume they all get put together to one document, but obviously this doesn't work across files. Perhaps a good way to fix all of them would be to fix individual md files to link to the absolute url and then in the build process (the pdf generator tool), replace the absolute url with just the internal link.

If anyone's up for helping with this, would be happy of a PR that does it 🙏

@RichardLitt RichardLitt added the help wanted Extra attention is needed label Sep 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants