Deploying this Wiki

This wiki is a static site built with MkDocs + Material for MkDocs and hosted on Cloudflare Pages.

Workflow

flowchart LR
    A[Edit Markdown<br/>on a branch] --> B[Open a PR]
    B --> C[GitHub Action:<br/>mkdocs build --strict]
    B --> D[Cloudflare Pages<br/>preview URL]
    C & D --> E[Review & merge]
    E --> F[Cloudflare deploys main<br/>to production]

1. Create a branch, edit files in docs/, and add new pages to nav: in mkdocs.yml.
2. Open a pull request. The Build wiki GitHub Action fails the PR if there are broken links or nav errors.
3. Cloudflare Pages comments on the PR with a preview URL.
4. Merge to main. Cloudflare deploys to production automatically.

Run locally

python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -r requirements.txt
mkdocs serve        # open http://127.0.0.1:8000

One-time Cloudflare Pages setup

1. Sign in at dash.cloudflare.com and go to Workers & Pages → Create → Pages → Connect to Git.
2. Authorize GitHub and pick the jac9s/anime-game-wiki repo.

3. Build settings:

   Setting	Value
   Production branch	main
   Framework preset	MkDocs (or None)
   Build command	pip install -r requirements.txt && mkdocs build
   Build output directory	site
   Environment variable	PYTHON_VERSION = 3.12

4. Click Save and Deploy. The site goes live at https://<project-name>.pages.dev. If you name the project something other than riftbloom-wiki, update site_url in mkdocs.yml.

5. (Optional) Add a custom domain under Custom domains.

Preview deployments for PRs are on by default with the Git integration.

Alternative: deploy with Wrangler

npm install -g wrangler
wrangler login
mkdocs build
wrangler pages deploy site --project-name riftbloom-wiki

wrangler.toml in the repo root already sets pages_build_output_dir = "site".