update lychee config

Author: tomeichlersmith

.github/workflows/mdbook.yml

@@ -47,7 +47,12 @@ jobs:
         uses: lycheeverse/lychee-action@v2
         with:
           fail: true
-          args: ./docs/book
+          args: >-
+            --verbose
+            --no-progress
+            --config docs/lychee.toml
+            --root-dir "${{ github.workspace }}/docs/book"
+            ./docs/book
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

docs/.gitignore

@@ -1 +1,2 @@
 book
+.lycheecache

docs/lychee.toml

@@ -0,0 +1,21 @@
+# configuration of lychee link checker
+#  https://lychee.cli.rs/usage/config/
+
+# enable link checking to avoid rate limiting when doing many runs locally in sequence
+cache = true
+
+# skip over URLs matching these regex
+exclude = [
+  # skip DocDB, we want to link to internal documents
+  '^https://projects-docdb\.fnal\.gov',
+  # this is a private repository
+  '^https://github\.com/LDMX-Software/(ldmx-sw-scripts|ldmx-analysis)',
+  # this is timing out for some reason
+  '^http://www\.adobe\.com'
+]
+
+# don't check these files
+exclude_path = [
+  # skip the "print.html" page generated by mdbook because it just repeats any previous errors
+  'book/print.html'
+]