Skip to content

Cloudflare Pages Deployment

Overview

The documentation site can be deployed to Cloudflare Pages using the MkDocs build output in docs_site/.

Build Settings

  • Framework preset: None
  • Build command: bash scripts/build-docs.sh
  • Build output directory: docs_site
  • Root directory: /

GitHub Actions Deployment

This repository includes: - .github/workflows/docs-cloudflare-pages.yml

Required repository secrets: - CLOUDFLARE_API_TOKEN - CLOUDFLARE_ACCOUNT_ID

Optional repository variable: - CLOUDFLARE_PAGES_PROJECT

Default project name used by the workflow:

gmpro-manual

Manual Deployment

If you want to deploy manually instead of using GitHub Actions:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements-docs.txt
bash scripts/build-docs.sh
npx wrangler pages deploy docs_site --project-name gmpro-manual

Notes

  • Cloudflare Pages hosts the generated static site
  • MkDocs is still the correct build tool
  • screenshots in docs/manual/assets/ are published automatically with the rest of the site