ci: catch broken markdown links

.github/workflows/pull_request.yml

@@ -64,10 +64,10 @@ jobs:
         run: |
           git config --global --add safe.directory "$GITHUB_WORKSPACE"
 
-      - name: Run style checks
+      - name: Run style and markdown link checks
         shell: sh
         run: |
-          pre-commit run --all || (echo "Style checks failed, please install pre-commit and run pre-commit run --all and push the change"; echo ""; git --no-pager diff; exit 1)
+          pre-commit run --all || (echo "Style or markdown link checks failed, please install pre-commit and run pre-commit run --all and push the change"; echo ""; git --no-pager diff; exit 1)
 
   docs:
     needs: lint

.lycheeignore

@@ -0,0 +1,4 @@
+^file://.*/Source/Cmlx/fmt/.*
+^file://.*/Source/Cmlx/json/.*
+^file://.*/Source/Cmlx/metal-cpp/.*
+^file://.*/Source/(MLX|MLXNN|MLXOptimizers)/Documentation\.docc/(mlx|mlxnn|mlxoptimizers)$

.pre-commit-config.yaml

@@ -13,3 +13,12 @@ repos:
   rev: v0.6.10
   hooks:
     - id: cmake-format
+
+- repo: https://github.com/lycheeverse/lychee.git
+  rev: lychee-v0.24.2
+  hooks:
+    - id: lychee
+      args:
+        - --no-progress
+        - --offline
+      types: [markdown]

ACKNOWLEDGMENTS.md

@@ -7,6 +7,8 @@ with a short description of your contribution(s) below. For example:
 
 MLX Swift was developed with contributions from the following individuals:
 
+- [Ledio Berdellima](https://github.com/x-n2o): Added Markdown link checks in pre-commit/CI.
+
 <a href="https://github.com/ml-explore/mlx-swift/graphs/contributors">
   <img class="dark-light" src="https://contrib.rocks/image?repo=ml-explore/mlx-swift&anon=0&columns=20&max=100&r=true" />
 </a>