name: Docs
on:
push:
branches: [main]
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: Generate sitemap.xml
run: |
base="https://abecoull.github.io/prism-q"
tmp="$(mktemp)"
{
echo '<?xml version="1.0" encoding="UTF-8"?>'
echo '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'
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" ]; then
loc="$base/"
elif cmp -s "docs/book/$f" docs/book/index.html; then
continue
else
loc="$base/$f"
fi
printf ' <url><loc>%s</loc></url>\n' "$loc"
done
echo '</urlset>'
} > "$tmp"
mv "$tmp" 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