markdown-link-check

markdown-link-check copied to clipboard

Firstly, thanks for building such a great tool. I'm seeing some inconsistent and incorrect results in the report when I try this out. Let me mention a few examples here.

Firstly, some context.

• This is the command I use: find . -type f -name '*.md' ! -path '/docs/**/*' | xargs -L1 markdown-link-check --config config.json

• config.json is used because my documentation site has {{base_path}} in front of all the links to make them relative. This is the content of that file:

{
  "replacementPatterns": [
    {
      "pattern": "{{base_path}}/",
      "replacement": "https://apim.docs.wso2.com/en/4.0.0/"
    }
  ]
} 

With the above setup, it seems to work and all internal broken links seem to be highlighted in the report, but there are some exceptions.

Exception 1

The following is an incorrect link that exists in a file within the directory:

({{base_path}}/install-and-setup/setup/mi-setup/setup/user_stores/setting_up_a_userstore)

This did not get highlighted in the report when I ran the command.

Exception 2

The following is an external link that is marked as incorrect.

[✖] https://mvnrepository.com/artifact/com.stripe/stripe-java/9.8.0

However, this link is correct and seems to work.

---

These are just examples, there are more instances like this. What am I doing wrong here and what can I do to fix it?