1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
name: Docs
on:
push:
branches:
paths:
- 'docs/**'
- '.github/workflows/docs.yml'
pull_request:
paths:
- 'docs/**'
- '.github/workflows/docs.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: taiki-e/install-action@v2
with:
tool: mdbook@0.4.52
- name: Install mdBook preprocessors
run: cargo install --locked mdbook-admonish@1.20.0 mdbook-mermaid@0.14.0 mdbook-katex@0.9.4
- name: Build book
run: mdbook build docs
- name: Add canonical links and generate sitemap.xml
# mdBook exposes a chapter's source path but no helper to turn it into
# the rendered URL, so the per-page canonical link and og:url are
# inserted here, after the build, where every page's URL is known. The
# first chapter is also served as the site root and canonicalizes to it.
run: |
base="https://abecoull.github.io/prism-q"
pages="$(mktemp)"
find docs/book -name '*.html' \
! -name '404.html' ! -name 'print.html' ! -name 'toc.html' \
-printf '%P\n' | sort | while read -r f; do
if [ "$f" = "index.html" ] || cmp -s "docs/book/$f" docs/book/index.html; then
echo "$f $base/"
else
echo "$f $base/$f"
fi
done > "$pages"
while read -r f loc; do
sed -i "s|<meta charset=\"UTF-8\">|&\n <link rel=\"canonical\" href=\"$loc\">\n <meta property=\"og:url\" content=\"$loc\">|" "docs/book/$f"
done < "$pages"
{
echo '<?xml version="1.0" encoding="UTF-8"?>'
echo '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'
awk '{print $2}' "$pages" | sort -u | while read -r loc; do
printf ' <url><loc>%s</loc></url>\n' "$loc"
done
echo '</urlset>'
} > docs/book/sitemap.xml
- uses: actions/upload-pages-artifact@v5
with:
path: docs/book
deploy:
needs: build
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5