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

Fix relative URLs in reference #84

Merged
merged 1 commit into from
Mar 4, 2024
Merged

Conversation

richfab
Copy link
Contributor

@richfab richfab commented Mar 4, 2024

Problem

When clicking an anchor in the Table of Contents of the reference on https://gbfs.org/specification/reference/, the links redirect to the raw content on GitHub.

Solution

This PR fixes anchors in the reference.

The reference is fetched by the plugin mkdocs-embed-external-markdown. The plugin change log shows that version 3.x.x:

Added handling for relative links in the markdown, making them absolute based on the base URL.

We want the relative links to remain relative. So this PR downgrades the plugin to the version preceding this change: 2.3.0.

Before

Screen.Recording.2024-03-04.at.10.07.50.mov

After

Screen.Recording.2024-03-04.at.10.08.43.mov

Copy link
Contributor

@fredericsimard fredericsimard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me!

@richfab richfab merged commit 01370ec into master Mar 4, 2024
2 checks passed
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.

2 participants