Documentation Deployment¶
The documentation site is built with MkDocs Material and deployed by Cloudflare Pages from GitHub.
Source¶
- Repository:
rezabaram/fec-platform - Production branch:
main - MkDocs config:
mkdocs.yml - Docs source directory:
docs/ - Build output directory:
site/
Cloudflare Pages Settings¶
Use these settings in the Cloudflare Pages project:
| Setting | Value |
|---|---|
| Framework preset | None / Custom |
| Production branch | main |
| Build command | pip install -r requirements.txt && mkdocs build --strict |
| Build output directory | site |
| Root directory | repository root |
requirements.txt is committed at repository root so the Cloudflare build image installs the same MkDocs dependencies used locally.
Local Verification¶
Run:
bash
pip install -r requirements.txt
mkdocs build --strict
The generated site/ directory is a build artifact and should not be committed.