pre-commit: add `markdown-link-check` to check for dead links in Markdown files

[jbampton]

A docs repo that uses Markdown should use all the best tools to ensure its Markdown is correct etc.

So link checkers and linters are great.

I am suggesting markdown-link-check here but there is also lychee:

"Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more! "

https://github.com/lycheeverse/lychee

refs #29

But I could not get lychee working with pre-commit on Apache Sedona and there is an open issue regarding what I found

apache/sedona#1366

lycheeverse/lychee#1635

Otherwise markdown-link-check is a popular tool:

https://github.com/tcort/markdown-link-check

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#run-as-a-pre-commit-hook

The config file supports many options/parameters:

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#config-file-format

[dave2wave]

I'll need to investigate this one more deeply.

[dave2wave]

Go ahead with markdown-link-check

[dave2wave]

@jbampton if you are interested in continuing this contribution then please do so.

[dave2wave]

Now that I think about this I can see one concern. I am writing new content that is self referential to other pages that do not yet exist. These may be in the next PR or in another system.

If we implement this check then it is only a warning and not an error.

[dave2wave]

@jbampton Interested in checking your suggestions.

[jbampton]

The markdown-link-check has a config file where you can ignore paths

Example on mruby:

https://github.com/mruby/mruby/blob/master/.github/linters/mlc_config.json

This config file has a number of settings.

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#config-file-format

Maybe we can ignore those files ?

Last I tried I was unable to get the lychee link checker working with pre-commit.