2018-07-12 16:26:03 +00:00
|
|
|
#!/bin/sh
|
|
|
|
|
|
2019-02-26 13:50:07 +00:00
|
|
|
PATH_TO_SITE="${1:-/app/site}"
|
|
|
|
|
|
2018-07-12 16:26:03 +00:00
|
|
|
set -eu
|
|
|
|
|
|
|
|
|
|
[ -d "${PATH_TO_SITE}" ]
|
|
|
|
|
|
|
|
|
|
NUMBER_OF_CPUS="$(grep -c processor /proc/cpuinfo)"
|
|
|
|
|
|
|
|
|
|
echo "=== Checking HTML content..."
|
|
|
|
|
|
|
|
|
|
# Search for all HTML files except the theme's partials
|
|
|
|
|
# and pipe this to htmlproofer with parallel threads
|
|
|
|
|
# (one htmlproofer per vCPU)
|
|
|
|
|
find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \
|
|
|
|
|
-name "*.html" -print0 \
|
|
|
|
|
| xargs -0 -r -P "${NUMBER_OF_CPUS}" -I '{}' \
|
|
|
|
|
htmlproofer \
|
|
|
|
|
--check-html \
|
2018-12-19 16:36:04 +00:00
|
|
|
--check_external_hash \
|
2020-09-23 08:20:04 +00:00
|
|
|
--alt_ignore="/traefikproxy-vertical-logo-color.svg/" \
|
2018-12-19 16:36:04 +00:00
|
|
|
--http_status_ignore="0,500,501,503" \
|
2020-09-23 08:20:04 +00:00
|
|
|
--file_ignore="/404.html/" \
|
2022-01-24 10:08:05 +00:00
|
|
|
--url_ignore="/https://groups.google.com/a/traefik.io/forum/#!forum/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/github.com\/traefik\/traefik\/*edit*/,/github.com\/traefik\/traefik/,/doc.traefik.io/,/github\.com\/golang\/oauth2\/blob\/36a7019397c4c86cf59eeab3bc0d188bac444277\/.+/,/www.akamai.com/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io\/traefik-mesh/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/,/www.namesilo.com/,/www.youtube.com/,/www.linode.com/,/www.alibabacloud.com/,/www.cloudxns.net/,/www.vultr.com/" \
|
2019-02-26 13:50:07 +00:00
|
|
|
'{}' 1>/dev/null
|
2018-07-12 16:26:03 +00:00
|
|
|
## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration
|
|
|
|
|
|
2019-02-26 13:50:07 +00:00
|
|
|
echo "= Documentation checked successfully."
|
