[skip changelog] Disable internal anchor checks by link checker tool

Validation of links to internal anchors was recently added to the markdown-link-check tool used to check for broken
links in this project's documentation.

Although a much needed feature, unfortunately it does not currently support anchors created by HTML anchor tags.

For example, this is valid and common Markdown:

[click here](#some-anchor)
<a name="some-anchor"></a>

but will fail the check:

ERROR: 1 dead links found!
[x] #some-anchor -> Status: 404

This type of link markup is used by the protoc-gen-doc tool that generates the gRPC interface documentation, which
causes a spurious failure of the link check.

The solution is to configure markdown-link-check to skip these links (which was the behavior anyway with versions 3.8.7
and older). That will be reverted whenever the tool is able to correctly validate internal anchor links.

Loading branch information

per1234 committed Mar 22, 2022

commit b998c4753770a57ee9dfdad27bcf77e1646c75fa

[skip changelog] Disable internal anchor checks by link checker tool #1692

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.

Sign up for GitHub

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

Conversation 0 Commits 1 Checks 0 Files changed

Merged

[skip changelog] Disable internal anchor checks by link checker tool #1692

Changes from all commits

Commits

Show all changes
1 commit

Select commit

b998c47
[skip changelog] Disable internal anchor checks by link checker tool
per1234 Mar 22, 2022

File filter

Filter by extension

Filter by extension .json (1) All 1 file type selected

Viewed files

Conversations

Failed to load comments.

Loading

Jump to

Jump to file

Failed to load files.

Loading

Diff view

Unified

Split

Hide whitespace

Diff view

Unified

Split

Hide whitespace

[skip changelog] Disable internal anchor checks by link checker tool

Validation of links to internal anchors was recently added to the markdown-link-check tool used to check for broken links in this project's documentation. Although a much needed feature, unfortunately it does not currently support anchors created by HTML anchor tags. For example, this is valid and common Markdown: [click here](#some-anchor) <a name="some-anchor"></a> but will fail the check: ERROR: 1 dead links found! [x] #some-anchor -> Status: 404 This type of link markup is used by the protoc-gen-doc tool that generates the gRPC interface documentation, which causes a spurious failure of the link check. The solution is to configure markdown-link-check to skip these links (which was the behavior anyway with versions 3.8.7 and older). That will be reverted whenever the tool is able to correctly validate internal anchor links.

Loading branch information

per1234 committed Mar 22, 2022

commit b998c4753770a57ee9dfdad27bcf77e1646c75fa

3 changes: 3 additions & 0 deletions .markdown-link-check.json

Show comments
View file
Open in desktop

Original file line number Diff line number Diff line change

Expand Up @@ -3,6 +3,9 @@

"retryCount": 3,

"aliveStatusCodes": [200, 206],

"ignorePatterns": [

{

"pattern": "^#"

},

{

"pattern": "https?://localhost:\\d*/"

},

Expand Down

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[skip changelog] Disable internal anchor checks by link checker tool #1692

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,9 @@ @@
       "retryCount": 3,
       "aliveStatusCodes": [200, 206],
       "ignorePatterns": [
+        {
+          "pattern": "^#"
+        },
         {
           "pattern": "https?://localhost:\\d*/"
         },
@@ Expand Down @@