21 lines
859 B
Bash
21 lines
859 B
Bash
|
#!/usr/bin/env bash
|
||
|
|
# check-docs-links.sh - Suggest running markdown-link-check or lychee to find broken links in docs/
|
||
|
|
# Usage: run from repo root: ./docs/scripts/check-docs-links.sh
|
||
|
|
# Install: npm install -g markdown-link-check (or: cargo install lychee)
|
||
|
|
|
||
|
|
set -e
|
||
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||
|
|
DOCS_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
|
||
|
|
ROOT_DIR="$(cd "$DOCS_DIR/.." && pwd)"
|
||
|
|
|
||
|
|
echo "Docs directory: $DOCS_DIR"
|
||
|
|
echo "Repo root: $ROOT_DIR"
|
||
|
|
echo ""
|
||
|
|
echo "To check links in docs/, run one of:"
|
||
|
|
echo " (from repo root) npx markdown-link-check \"$DOCS_DIR/**/*.md\""
|
||
|
|
echo " (from repo root) lychee \"$DOCS_DIR/**/*.md\" --base \"$ROOT_DIR\""
|
||
|
|
echo ""
|
||
|
|
echo "Broken refs report (if generated): $ROOT_DIR/reports/BROKEN_REFERENCES_REPORT.md"
|
||
|
|
echo "Fix docs-internal and root links first; submodule links can be handled separately."
|
||
|
|
exit 0
|