Skip to content

docs: fix broken links #680

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

Merged
merged 13 commits into from
Nov 12, 2020
Merged

Conversation

MatanBobi
Copy link
Member

@MatanBobi MatanBobi commented Nov 12, 2020

This is now ready for review.
I added mdx suffix to missing files, removed the relative paths since they aren't needed and also added some titles to a few snippets I saw :)

@MatanBobi MatanBobi marked this pull request as ready for review November 12, 2020 10:23
Copy link
Collaborator

@alexkrolick alexkrolick left a comment

Choose a reason for hiding this comment

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

👍

I wish adding the .mdx extension wasn't necessary. The file extension of the source markup doesn't affect the link for the compiled site :/

But it's important to get these broken links fixed, so I am OK with merging

@MatanBobi
Copy link
Member Author

MatanBobi commented Nov 12, 2020

👍

I wish adding the .mdx extension wasn't necessary. The file extension of the source markup doesn't affect the link for the compiled site :/

But it's important to get these broken links fixed, so I am OK with merging

I definitely agree, maybe we can take it up with docusaurus people..

@alexkrolick
Copy link
Collaborator

Yeah, let's open an issue about the extension in links on the docusaurus side

@alexkrolick alexkrolick merged commit 69cfe0a into testing-library:master Nov 12, 2020
@MatanBobi
Copy link
Member Author

@alexkrolick looks like in the docs they never claim that omitting the file extension will work, I probably found it redundant because it worked on localhost:
https://v2.docusaurus.io/docs/markdown-features#referencing-other-documents

Do you think we should maybe open a feature request for that? Since they never said it's supported I guess it's not a bug..

@alexkrolick
Copy link
Collaborator

It works without the extension because the links pass through the markdown parser as-is, and the folder structure of the docs matches the output directory structure, so relative links remain the same

@MatanBobi
Copy link
Member Author

Sorry but I'm not sure I 100% understand what we want from docusaurus then.
Basically what you're saying is that it will work as long as the file is already there (was loaded), so I'm not sure if that's a bug or a new feature..

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