mdlink-check.sh: Add comment about why we are setting the magic conf

gruntwork-io · Feb 5, 2020 · f0f78b6 · f0f78b6
1 parent f9b8feb
commit f0f78b6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/hooks/mdlink-check.sh b/hooks/mdlink-check.sh
@@ -13,6 +13,8 @@ if ! command -v markdown-link-check; then
   exit 1
 fi
 
+# This is the recommended way to set the project root for properly resolving absolute paths. See
+# https://github.com/tcort/markdown-link-check/issues/16 for more info.
 TMP_CONFIG="$(mktemp)"
 cat > "$TMP_CONFIG" <<EOF
 {