Updates for link checking

ponylang · Feb 13, 2024 · 6378fd2 · 6378fd2
1 parent 48b007e
commit 6378fd2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/.github/workflows/verify-site-builds.yml b/.github/workflows/verify-site-builds.yml
@@ -18,6 +18,11 @@ jobs:
           INSIDERS_PAT: ${{ secrets.MATERIAL_INSIDERS_ACCESS }}
       - name: Build site
         run: mkdocs build
+        env:
+          // by turning off, we can get checking of anchor links on the site
+          // not just external urls. see...
+          // https://github.com/manuzhang/mkdocs-htmlproofer-plugin/issues/46#issuecomment-1494267151
+          USE_DIRECTORY_URLS: false
       - name: Send alert on failure
         if: ${{ failure() }}
         uses: zulip/github-actions-zulip/send-message@b62d5a0e48a4d984ea4fce5dd65ba691963d4db4

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,7 +4,7 @@ copyright: Copyright &copy; 2024 The Pony Developers
 edit_uri: edit/main/docs/
 repo_url: https://github.com/ponylang/ponylang-website/
 site_url: https://www.ponylang.io/
-use_directory_urls: true
+use_directory_urls: !ENV [USE_DIRECTORY_URLS, true]
 
 extra:
   generator: false
@@ -40,10 +40,10 @@ plugins:
   - ezlinks
   - htmlproofer:
       enabled: !ENV [ENABLED_HTMLPROOFER, True]
+      validate_external_urls: !ENV [VALIDATE_EXTERNAL_URLS, True]
       raise_error_after_finish: True
       raise_error_excludes:
         429: ["https://github.com/ponylang"]
-        404: ["https://github.com/ponylang"]
         429: ["https://medium.com"]
 
 theme: