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

Broken Markdown link detection should also work for internal links #4180

Closed
Zamiell opened this issue Feb 5, 2021 · 1 comment
Closed

Broken Markdown link detection should also work for internal links #4180

Zamiell opened this issue Feb 5, 2021 · 1 comment
Labels
closed: duplicate This issue or pull request already exists in another issue or pull request feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@Zamiell
Copy link
Contributor

Zamiell commented Feb 5, 2021

One fantastic feature of Docusaurus 2 is that it warns me if I have a broken link in one of my Markdown files:

warn Docs markdown link couldn't be resolved: (non_existent_page.md) in C:\Repositories\my-repo\docs\main.md for version current

This feature is really helpful and a huge time saver!

However, this feature does not work with internal links on the page.

For example, consider the following Markdown file:

### Section 1

This is section 1. By the way, you might want to also check out [section 2](#section-3).
<!-- Oops, I made a typo at the end of the previous line, and the link is now broken! -->

### Section 2

This is section 2.

Docusaurus won't warn me about the bug in this file, which is a real bummer. =(
Is this something that can be added?

@Zamiell Zamiell added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers labels Feb 5, 2021
@slorber
Copy link
Collaborator

slorber commented Feb 5, 2021

Yes, we definitively want this feature, duplicate of #3321

@slorber slorber closed this as completed Feb 5, 2021
@Josh-Cena Josh-Cena added closed: duplicate This issue or pull request already exists in another issue or pull request and removed status: needs triage This issue has not been triaged by maintainers labels Mar 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed: duplicate This issue or pull request already exists in another issue or pull request feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

3 participants