feat(v2): broken links detection #3059
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for docusaurus-2 ready! Built with commit 5af0b3b |
|
ready to review @yangshun opted for throwing an error on broken links by default, with ability to disable it (the error message mentions that config option) |
slorber
commented
Jul 15, 2020
| @@ -63,8 +63,6 @@ Strikethrough uses two tildes. ~~Scratch this.~~ | |||
|
|
|||
| [I'm a reference-style link][arbitrary case-insensitive reference text] | |||
|
|
|||
| [I'm a relative reference to a repository file](../blob/master/LICENSE) | |||
There was a problem hiding this comment.
FYI I removed it because this template link is actually broken (this was failing the CI).
It is interpreted as an internal SPA link, and ReactRouter shows the 404:
There was a problem hiding this comment.
Well then, I am glad this feature already found one broken link :)
# Conflicts: # packages/docusaurus/src/client/exports/Link.tsx # packages/docusaurus/src/server/configValidation.ts
|
Awesome! this is great. |
Vinnl
added a commit
to inrupt/solid-client-js
that referenced
this pull request
Jul 27, 2020
Docusaurus v2 alpha 59 adds broken link detection (facebook/docusaurus#3059), but that only works when linking to the source file.
Vinnl
added a commit
to inrupt/solid-client-js
that referenced
this pull request
Jul 27, 2020
Docusaurus v2 alpha 59 adds broken link detection (facebook/docusaurus#3059), but that only works when linking to the source file.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
We should be able to fail fast the build if there are broken links.
We can't necessarily detect external broken links, but at least ensure the internal links always match an existing route.
See also: #3048
Test Plan
TODO
Here's what it shows to the user, at the very end of the build (once all the broken links are collected):
It can also be a non-blocking error/log, or just be skipped, according to configuration
For links with anchor, not sure we can do anything easily... but at least the would lead to the correct page