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

yorinasub17 · yorinasub17 · commit f0f78b665081 · 2020-02-04T22:50:48.000-08:00
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
 {

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@ if ! command -v markdown-link-check; then`
`13`	`13`	`exit 1`
`14`	`14`	`fi`
`15`	`15`
	`16`	`+# This is the recommended way to set the project root for properly resolving absolute paths. See`
	`17`	`+# https://github.com/tcort/markdown-link-check/issues/16 for more info.`
`16`	`18`	`TMP_CONFIG="$(mktemp)"`
`17`	`19`	`cat > "$TMP_CONFIG" <<EOF`
`18`	`20`	`{`