diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 9b9a69d49..02c2c0200 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -65,6 +65,7 @@ jobs: run: | mkdir -p site cp -r target/book/. site/ + bash docs/book/seo.sh site # canonical links, robots.txt, sitemap.xml cp -r dist/web site/app - uses: actions/configure-pages@v5 id: pages diff --git a/docs/book/seo.sh b/docs/book/seo.sh new file mode 100755 index 000000000..748bc7bef --- /dev/null +++ b/docs/book/seo.sh @@ -0,0 +1,32 @@ +#!/usr/bin/env bash +# Adds to every built book page and writes robots.txt and sitemap.xml. +# mdBook's templates cannot turn a chapter's .md path into its .html URL, so this runs on the built +# tree (usage: seo.sh ). index.html and introduction.html are the same page: both point at /. +set -euo pipefail +dir="${1:?usage: seo.sh }" +base="https://docs.solidcraft.io" +cd "$dir" +urls=() +while IFS= read -r f; do + f="${f#./}" + case "$f" in + 404.html|toc.html) # not content pages: keep them out of the index + sed -i 's|||' "$f"; continue ;; + esac + grep -q 'rel="canonical"' "$f" && continue # mdBook's redirect stubs already name their target + case "$f" in + index.html|introduction.html) path="" ;; + */index.html) path="${f%index.html}" ;; + *) path="$f" ;; + esac + url="$base/$path" + sed -i "s|||" "$f" + [ "$f" = print.html ] || [ "$f" = introduction.html ] || urls+=("$url") +done < <(find . -name '*.html' | sort) +{ + echo '' + echo '' + for u in "${urls[@]}"; do echo " $u"; done + echo '' +} > sitemap.xml +printf 'User-agent: *\nAllow: /\n\nSitemap: %s/sitemap.xml\n' "$base" > robots.txt