Add pre-commit hook to check for dead links in markdown files

[pankajkoti]

The pre-commit hook checks that there are no dead links in the
markdown files of the repo.

Reference: https:/tcort/markdown-link-check

closes: #511

[pankajkoti]

Currently, there are no dead links in the repo, but I purposely modified a link to test that the hook works fine.

Below is the link I modified to a dead one.

And the outcome of the pre-commit hook is:

[codecov]

Codecov Report

Merging #524 (1735113) into main (0a9e000) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #524   +/-   ##
=======================================
  Coverage   98.28%   98.28%           
=======================================
  Files          72       72           
  Lines        3972     3972           
=======================================
  Hits         3904     3904           
  Misses         68       68           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0a9e000...1735113. Read the comment docs.

[phanikumv]

Does this work if there is a dead link in CHANGELOG.rst. I guess it would..?

[pankajkoti]

Does this work if there is a dead link in CHANGELOG.rst. I guess it would..?

unfortunately, no, it doesn't. It only works for markdown files (files with .md extension)