doc.linea icon indicating copy to clipboard operation
doc.linea copied to clipboard

Issues with `markdown-link-check-disable-next-line`

Open mapachurro opened this issue 1 year ago • 4 comments

in index.mdx within /docs/build-on-linea/linea-version, the markdown link check escape tags are throwing errors.

I'm going to comment them out, for now. This seems to be a misalignment between tooling, ie, how does the link checker parse HTML in an MDX context.

image

mapachurro avatar Mar 06 '24 13:03 mapachurro

I think it might have been me who deliberately added these. In some cases it's the only way to get the link linter to pass. The root cause is the linter, as since it throws errors for functional links, we're left with two choices:

  1. Ignore the failed linter, double check the links it identifies as broken do actually work, and merge anyway
  2. Add these ^ commands to pages that throw errors to enable the linter to pass, but break the formatting.

jlwllmr avatar Mar 07 '24 16:03 jlwllmr

Yeah I've also added them for the same reason mentioned by Joel. Sometimes I use it because some websites block the job from checking (probably with DDOS protection).

Edit. Actually I think I may have added those tags.

An alternate solution is to perhaps have a config file that uses ignorePatterns for these links.

bgravenorst avatar Mar 14 '24 00:03 bgravenorst

@mapachurro and @jlwllmr this solution using a config file appears to work: https://github.com/Consensys/doc.zk-evm/pull/476

Let me know if you are happy with me to implement it. This solution is for any Github URL, but we can refine it if required.

Also there are quite a few Twitter URLs that use the escape tab. Should we include https://twitter.com/?

bgravenorst avatar Mar 14 '24 03:03 bgravenorst

@bgravenorst @mapachurro given we merged the solution, can we close this issue?

jlwllmr avatar Mar 28 '24 13:03 jlwllmr

Closing as this was fixed a while ago.

jlwllmr avatar Jun 05 '24 15:06 jlwllmr